List candidates

get

https://api.join.com/v3/candidates

Returns your company’s candidates as a paginated list, sorted by creation date, oldest first unless sort asks for newest first, each with a summary of every application they hold. Deleted candidates are never returned; archived candidates are. Supplying q switches the ordering to relevance, so a search and a stable creation-ordered walk cannot be combined — a cursor minted under one ordering is not replayable under the other. A search therefore takes no sort, and sending both is refused with filter_invalid. Filters combine with AND, and a filter matching nothing returns an empty list rather than a not-found.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 50

Defaults to 10

Number of records to return

cursor

string

Position from the previous response's nextCursor. Omit on the first request

sort

string

enum

Order by creation date: createdAt for oldest first, the default, or -createdAt for newest first. A cursor keeps the order it was read under

Allowed:

string

length between 1 and 255

Fuzzy search across first name, last name and email. Supplying it orders the results by relevance instead of by creation date

sourceId

integer

Filter by source id, as in the source.id of a candidate or an application

200The company’s candidates

401Authentication failed. Either the Authorization: Bearer header is missing (authentication_required), or the presented token is malformed, unknown, revoked, or belongs to a company that no longer has API access (token_invalid).

422A path parameter, query parameter or body field failed schema validation.

429The token exceeded its sustained (600/60s) or burst (100/10s) request quota. Retry after the number of seconds in Retry-After.

500An unexpected error occurred on JOIN’s side. The request may be retried.