Skip to main content
All list endpoints in the Promptster API use limit/offset pagination.

Parameters

The GET /v1/candidates endpoint uses a default limit of 50 and a max of 200. All other list endpoints default to 20 with a max of 100.

Response format

All paginated responses include metadata alongside the results:

Iterating through pages

To fetch all items, increment offset by limit until you have retrieved total items:

Timeline pagination

The GET /v1/sessions/:id/timeline endpoint uses cursor-based pagination instead of offset-based, since timelines can be very large: Response:
To paginate, pass the id of the last event as the after parameter: