List all candidates.

get

https://api.personio.de/v2/recruiting/candidates

Returns a list of candidates for an authorized company, sorted by last updated date, newest first. The endpoint supports pagination. The endpoint requires the personio:recruiting:read scope.

Note

Currently, the Candidates and Applications API does not return custom attributes and tags. Please consider this limitation when using the API.

Warning

This endpoint is in beta, and may be subject to change. Please report any bugs to Help & Feedback section.

Query Params

limit

integer

1 to 200

Defaults to 100

The amount of resources to be returned per one request. It can range between 1 and 200, and the default is 100.

cursor

string

The pagination cursor to navigate over to the next list of resources. If you pass a specific limit to your request, or you rely on the default value of the number of resources to be returned, then your subsequent call has to include the cursor in order to retrieve the next list of resources. If cursor is missing, the first page is returned.

updated_at.lt

date-time

Return candidates updated before given time. Mutually exclusive with updated_at.gt.

updated_at.gt

date-time

Return candidates updated after given time. Mutually exclusive with updated_at.lt.

string

Return candidates with given email.

Headers

Beta

string

Beta: true header is required to opt-in.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Successful response.

400Bad request.