Skip to main content
GET
List data checkpoints

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app.

Query Parameters

entity_name
string[]

Entity to list checkpoints for. Repeat it to list several, as in ?entity_name=Invoice&entity_name=Customer, up to 200. Leave it out to list every entity's checkpoints. A name the app has no entity for matches nothing rather than failing.

cursor
string

Pagination cursor from previous response.

limit
integer
default:50

Items per page. Max 200. Defaults to 50, and a larger value is treated as 200.

from
string

Earliest data_as_of to include, as an ISO 8601 timestamp such as 2026-06-01T00:00:00Z. A timestamp with no offset is read as UTC.

to
string

Only include checkpoints whose data_as_of is before this moment, as an ISO 8601 timestamp such as 2026-06-08T00:00:00Z. A timestamp with no offset is read as UTC.

Response

One page of checkpoints.

One page of an app's version-history checkpoints, newest first.

items
CheckpointListItem · object[]
required

The page's checkpoints, newest first.

Example:
next_cursor
string | null

Cursor for fetching the next page. The value is null if there are no more pages. A full page always carries one, so the page after it can come back empty.

Example:

"gAAAAABn7vJ..."