List candidates

Every candidate in the organization. The company is taken from the permission check, never from a query parameter, so naming another organization's company changes nothing.

Authorization

bearerAuth

AuthorizationBearer <token>

An API key from Settings > API access, sent as Authorization: Bearer sp_live_.... Send exactly one credential per request; a request carrying both a bearer token and a session cookie is rejected rather than resolved by precedence.

In: header

Query Parameters

pageNumber?integer

1-based page number.

Range1 <= value

Default1

pageSize?integer

Page size. Clamped server-side, so a very large value returns the maximum.

Range1 <= value

Default20

jobId?string

Narrow to one job.

search?string

Response Body

`application/json`

curl -X GET "https://example.com/candidates"

{  "currentPage": 0,  "pageSize": 0,  "totalCount": 0,  "hasMore": true,  "data": [    {      "id": "string",      "jobId": "string",      "jobTitle": "string",      "firstName": "string",      "lastName": "string",      "headline": "string",      "stage": "string",      "decision": "string",      "linkedinUrl": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}

Authorization

Query Parameters

Response Body

200application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`