Skip to main content
GET
List candidates in your CRM

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
string

Free text over name, headline, location and employer names, e.g. Jane Doe or Austin. Name matches first.

Minimum string length: 1
cursor
integer | null
default:0

Previous page's nextCursor, same filters. Omit for first page.

Required range: x >= 0
limit
integer
default:10

Candidates per page. Default 10; above 50 lowered to 50.

Required range: x >= 1
tags

CRM tag names, repeat for several, e.g. tags=backend&tags=senior. Matches ANY.

relationshipStatus

Your working relationship with candidate, repeat for several; matches ANY. Unknown value ignored.

Available options:
SOURCED,
CONTACTED,
REPLIED,
SCHEDULED_CALL,
SCREENED,
ACTIVE,
STAY_IN_TOUCH,
BACKBURNER
linkedinUrl
string

Candidate LinkedIn profile link, e.g. https://www.linkedin.com/in/janedoe. Other LinkedIn link returns 400 invalid_linkedin_url. No match returns empty list.

Minimum string length: 1
email
string

Email you can see for candidate, exact, case-insensitive, e.g. jane@example.com. No match returns empty list.

Minimum string length: 1

Response

200 - application/json

Success

candidates
object[]
required
nextCursor
number