Skip to main content
GET
List candidates

Authorizations

Authorization
string
header
required

Company-scoped API key. Production keys are prefixed sk_live_, sandbox keys sk_test_, each followed by 22 base62 characters (pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the TapTalent dashboard under Account Settings → Developers → API Key Management; a key is shown once at generation and old keys are invalidated immediately on regeneration.

Query Parameters

jobIds
string

Comma-separated list of job IDs (integers) to filter candidates by.

stageIds
string

Comma-separated list of stage IDs to filter candidates by.

searchTerm
string

Search term to filter candidates by name, email, or other fields.

currentJobTitle
string

Filter by candidate's current job title.

currentCompany
string

Filter by candidate's current company.

candidatePhone
string

Filter by candidate's phone number.

candidateEmail
string

Filter by candidate's email address.

skills
string

Comma-separated list of skills to filter by (case-insensitive).

groupIds
string

Comma-separated list of group IDs to filter by.

includeOnlyRejecetedCandidates
enum<string>
default:false

Set to "true" to include only rejected candidates. Note: the misspelling of "Rejeceted" in this parameter name is intentional and required — it is the actual wire format accepted by the API. Passed as a string, not a boolean.

Available options:
true,
false
source
string

Filter by candidate source.

perPage
enum<integer>
default:10

Items per page. Must be one of: 10, 20, 40, 80, 100.

Available options:
10,
20,
40,
80,
100
pageNumber
integer
default:0

Page number. 0-indexed — the first page is pageNumber=0 (unlike most other paginated endpoints, which are 1-indexed).

Response

Paginated list of candidates matching the filters.

Success envelope for the list-candidates endpoint.

status
enum<string>
required

Response status ("success").

Available options:
success
data
object
required