Skip to main content
GET
/
candidates
Get candidates with cursor-based pagination
curl --request GET \
  --url https://api.gospott.com/candidates \
  --header 'x-api-key: <api-key>'

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Query Parameters

limit
number
default:25

Number of candidates to return per page (min: 1, max: 50, default: 25)

Required range: 1 <= x <= 50
modifiedSince
string<date-time>

Filter candidates modified on or after this date. Useful for incremental synchronization. Defaults to beginning of time if not provided.

Example:

"2024-11-01T00:00:00.000Z"

cursor
string

Base64-encoded cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. Omit for the first page.

Example:

"eyJtb2RpZmllZEF0IjoiMjAyNC0xMS0wNlQxMDozMDowMC4wMDBaIiwiaWQiOiJjYW5kaWRhdGUtMTIzIn0="

Response

Candidates retrieved successfully