Candidates

List candidates

Returns a list of candidates. Uses cursor pagination.

get/candidates

Request

The document declares no server URL.
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/spott/apis/spott-webhooks/docs/candidates/get.ts
A function with typed inputs. Its response is checked against the schema.

limitinteger

Example:25

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

cursorstring

Example:eyJtb2RpZmllZEF0IjoiMjAyNC0xMS0wNlQxMDozMDowMC4wMDBaIiwiaWQiOiJjYW5kaWRhdGUtMTIzIn0=

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

modifiedSincestring date-time

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

modifiedUntilstring date-time

Filter candidates by sync watermark on or before this date. Useful for bounded synchronization snapshots. If omitted, no upper bound is applied.

listIdsstring[]

Filter candidates by candidate list IDs.

[
  "candidate-list-123",
  "candidate-list-456"
]

includestring[] required

Optional related resources to include in the response. Allowed values: skills.

[
  "skills"
]

Successfully retrieved candidates. Returns items array with pagination info containing cursor for the next page.

No recorded changes to this operation across all 1 revision of this API.