API docs by Redocly

Talenteria API (v1)

Download OpenAPI specification:

Talenteria API v1 - Applications

Apply to the job with resume

Apply to the job with resume

Authorizations:
Bearer
path Parameters
jobId
required
integer<int32>
Request Body schema:
externalApplicationId
string or null
email
string or null<email>
personalUniqueId
string or null
firstName
string or null
lastName
string or null
phone
string or null
object (Location)
source
string or null
required
object (Document)
Array of objects or null (CustomField)

Responses

Request samples

Content type
{
  • "externalApplicationId": "string",
  • "email": "user@example.com",
  • "personalUniqueId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "location": {
    },
  • "source": "string",
  • "resume": {
    },
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidate": {
    }
}

Apply to the Talent Pool with resume

Apply to the Talent Pool with resume

Authorizations:
Bearer
path Parameters
talentPoolId
required
integer<int32>
Request Body schema:
email
string or null<email>
personalUniqueId
string or null
firstName
string or null
lastName
string or null
phone
string or null
object (Location)
source
string or null
required
object (Document)
Array of objects or null (CustomField)

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "personalUniqueId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "location": {
    },
  • "source": "string",
  • "resume": {
    },
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidate": {
    }
}

Apply to AI-recommended Talent Pools with resume

Apply to AI-recommended Talent Pools with resume

Authorizations:
Bearer
Request Body schema:
email
string or null<email>
personalUniqueId
string or null
firstName
string or null
lastName
string or null
phone
string or null
object (Location)
source
string or null
talentPoolJobCategories
Array of strings or null
required
object (Document)
Array of objects or null (CustomField)

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "personalUniqueId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "location": {
    },
  • "source": "string",
  • "talentPoolJobCategories": [
    ],
  • "resume": {
    },
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidate": {
    }
}

Talenteria API v1 - Auth

Authenticate API client

Authenticate API client

Authorizations:
Bearer
Request Body schema:
clientId
required
string<uuid>
clientSecret
required
string non-empty

Responses

Request samples

Content type
{
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "clientSecret": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "token": "string"
}

Get current API client

Get current API client

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "client": {
    }
}

Talenteria API v1 - Candidates

Get Candidate by email

Get Candidate by email

Authorizations:
Bearer
path Parameters
email
required
string^\S+@\S+\.\S+$

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidate": {
    }
}

Get Candidate by personal unique id

Get Candidate by personal unique id

Authorizations:
Bearer
path Parameters
personalUniqueId
required
string

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidate": {
    }
}

Talenteria API v1 - Jobs

Get job openings

Get job openings

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "jobs": [
    ],
  • "totalRecords": 0
}

Create new job opening

Create new job opening

Authorizations:
Bearer
Request Body schema:
externalId
string or null
status
string or null

[Open, Draft, On Hold, Closed]

category
string or null
object (Client)
title
required
string non-empty
employmentType
string or null
referenceNumber
string or null
department
string or null
object (Location)
object (SalaryDetails)
description
string or null
responsibilities
string or null
requirements
string or null
benefits
string or null
dueDate
string or null<date-time>
object (Document)
Array of objects or null (CustomField)

Responses

Request samples

Content type
{
  • "externalId": "string",
  • "status": "string",
  • "category": "string",
  • "client": {
    },
  • "title": "string",
  • "employmentType": "string",
  • "referenceNumber": "string",
  • "department": "string",
  • "location": {
    },
  • "salary": {
    },
  • "description": "string",
  • "responsibilities": "string",
  • "requirements": "string",
  • "benefits": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "jobDescription": {
    },
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "job": {
    }
}

Get job opening by id

Get job opening by id

Authorizations:
Bearer
path Parameters
jobId
required
integer<int32>

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "job": {
    }
}

Update job opening by id

Update job opening by id

Authorizations:
Bearer
path Parameters
jobId
required
integer<int32>
Request Body schema:
externalId
string or null
status
string or null

[Open, Draft, On Hold, Closed]

category
string or null
client
string or null
title
required
string non-empty
employmentType
string or null
referenceNumber
string or null
department
string or null
object (Location)
object (SalaryDetails)
description
string or null
responsibilities
string or null
requirements
string or null
benefits
string or null
dueDate
string or null<date-time>
Array of objects or null (CustomField)

Responses

Request samples

Content type
{
  • "externalId": "string",
  • "status": "string",
  • "category": "string",
  • "client": "string",
  • "title": "string",
  • "employmentType": "string",
  • "referenceNumber": "string",
  • "department": "string",
  • "location": {
    },
  • "salary": {
    },
  • "description": "string",
  • "responsibilities": "string",
  • "requirements": "string",
  • "benefits": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "job": {
    }
}

Get job opening candidates by id

Get job opening candidates by id

Authorizations:
Bearer
path Parameters
jobId
required
integer<int32>

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidates": [
    ],
  • "totalRecords": 0
}

Get job opening by external id

Get job opening by external id

Authorizations:
Bearer
path Parameters
externalJobId
required
string

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "jobs": [
    ],
  • "totalRecords": 0
}

Update job opening by external id

Update job opening by external id

Authorizations:
Bearer
path Parameters
externalJobId
required
string
Request Body schema:
externalId
string or null
status
string or null

[Open, Draft, On Hold, Closed]

category
string or null
client
string or null
title
required
string non-empty
employmentType
string or null
referenceNumber
string or null
department
string or null
object (Location)
object (SalaryDetails)
description
string or null
responsibilities
string or null
requirements
string or null
benefits
string or null
dueDate
string or null<date-time>
Array of objects or null (CustomField)

Responses

Request samples

Content type
{
  • "externalId": "string",
  • "status": "string",
  • "category": "string",
  • "client": "string",
  • "title": "string",
  • "employmentType": "string",
  • "referenceNumber": "string",
  • "department": "string",
  • "location": {
    },
  • "salary": {
    },
  • "description": "string",
  • "responsibilities": "string",
  • "requirements": "string",
  • "benefits": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "job": {
    }
}

Get job opening candidates by external id

Get job opening candidates by external id

Authorizations:
Bearer
path Parameters
externalJobId
required
string

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidates": [
    ],
  • "totalRecords": 0
}

Talenteria API v1 - Talent Pools

Get Talent Pools openings

Get Talent Pools openings

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "talentPools": [
    ],
  • "totalRecords": 0
}

Create new talent pool

Create new talent pool

Authorizations:
Bearer
Request Body schema:
title
required
string non-empty
location
string or null
description
string or null
category
required
string non-empty
publishOnExternalSite
boolean or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "location": "string",
  • "description": "string",
  • "category": "string",
  • "publishOnExternalSite": true
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "talentPool": {
    }
}

Get talent pool by id

Get talent pool by id

Authorizations:
Bearer
path Parameters
talentPoolId
required
integer<int32>

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "talentPool": {
    }
}

Update Talent Pool by id

Update Talent Pool by id

Authorizations:
Bearer
path Parameters
talentPoolId
required
integer<int32>
Request Body schema:
title
string or null
location
string or null
description
string or null
category
string or null
publishOnExternalSite
boolean or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "location": "string",
  • "description": "string",
  • "category": "string",
  • "publishOnExternalSite": true
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "talentPool": {
    }
}

Get Talent Pool candidates by id

Get Talent Pool candidates by id

Authorizations:
Bearer
path Parameters
talentPoolId
required
integer<int32>

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorMessage": "string",
  • "message": "string",
  • "httpResponseCode": 0,
  • "candidates": [
    ],
  • "totalRecords": 0
}