Skip to content

Retrieve a page of anonymised candidates

Request

Fetches a paginated array of anonymised candidates. Optionally filter candidates by their ISCO (International Standard Classification of Occupations) codes.

Security
ApiKeyAuth
Query
pageinteger, >= 0

The page number for pagination

Default:0
limitinteger, [ 1 .. 100 ]

The number of results per page

Default:10
locationstring

A list of ISO 3166-1 alpha-2 location codes to filter candidates by their current location. Provide one or more ISO codes as a comma-separated list (e.g., US,GB).

Example:location=US,GB
nationalitystring

A list of ISO 3166-1 alpha-2 nationality codes to filter candidates by their nationality. Provide one or more ISO codes as a comma-separated list (e.g., FR,DE).

Example:nationality=FR,DE
occupationstring

A list of ISCO codes to filter candidates by their occupations. Provide one or more ISCO codes as a comma-separated list (e.g., 1234,5678).

Example:occupation=1234,5678
includeEmployedboolean

Flag to include candidate profiles with an "employed" status in the results. Defaults to false.

Default:false
curl -i -X GET \
  'https://tc-api.redocly.app/_mock/openapi/v1/candidates?page=0&limit=10&location=US%2CGB&nationality=FR%2CDE&occupation=1234%2C5678&includeEmployed=false' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

A page of anonymised candidates

Bodyapplication/json
contentArray of objects(Candidate)
totalElementsinteger
totalPagesinteger
sizeinteger
numberinteger
Response
{
  "content": [
    { … }
  ],
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "number": 0
}