List candidates

get

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

Returns your company’s candidates, each with their application summaries. Archived candidates are included; deleted candidates are excluded.

Listing and searching

Without q, results use creation order: oldest first by default, or newest first with sort.
With q, results use relevance order. Do not send sort with q; this returns filter_invalid.
A cursor belongs to its original ordering. Do not reuse it when switching between a search and a creation-ordered list.
Filters combine with AND. No matches returns an empty list. Follow nextCursor until it is null.

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