Skip to main content
GET
List candidate to-do's

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

Query Parameters

limit
integer
default:25

Number of to-do's to return per page (min: 1, max: 50, default: 25).

Required range: 1 <= x <= 50
Example:

25

cursor
string

Opaque cursor string for pagination. Use the cursor value from a previous response to fetch the next page. Omit for the first page.

isCompleted
boolean

Filter on completion state. Omit to receive both open and completed to-do's.

Example:

false

Response

The to-do's of the candidate, with pagination metadata.

items
object[]
required
pagination
object
required