Get All Assignments/Guide (Deprecated)

Get all assignment for a specified guide

❗️

Deprecated

This endpoint will be rate limited soon and will be shut down in late 2025. You should migrate to Get All Guide Assignments in Date Range. The new endpoint gives these advantages:

  • Fetch with a date range to retrieve only assignments that have been updated since a certain time (our most requested API feature)
  • Pagination for improved performance
  • By omitting Guide ID, a single API call can fetch assignments for all the Guides that have new data for you - no need to iterate over every guide ID.
Old WayNew Way
For every guide you have, hit this endpoint once per guide a few times per day and get and process every historical record everHit the new endpoint, without a Guide ID, with pagination, and receive data for all guides that have new data - it only returns the new data
Fetch a single guide's assignments one-off using this endpointFetch a single guide's assignments with the new endpoint one-off, with pagination and (optional) date range

⚠️ Legacy Mode Support

This endpoint supports the optional query parameter legacy_mode for accounts created before November 11, 2025.

If you use legacy_mode, the API will bypass standard pagination and return the full dataset in a single response.

We strongly recommend migrating to the standard, paginated response format, as legacy mode support may be deprecated in a future API version. At the moment, legacy_mode defaults to true.

Path Params
string
required

ID of the guide to get assignments for

Query Params
int32

Optional parameter: only assignments for this user id will be returned in the response

boolean
Defaults to true

For accounts provisioned prior to November 11, 2025, the optional query parameter legacy_mode can be set to bypass pagination. When legacy_mode is enabled, the API will return the entire result set in a single, non-paginated response.

int32
Defaults to 1

Page of results to return

int32
Defaults to 20

Number of results to return per page (1-200)

Response

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json