563848e0ecc0
List roster records with forward cursor pagination
Returns a page of roster records for the tenant named in the tenant-id header, walking forward through the set.
When to use: call this for straightforward forward-only paging; use GET /roster-records instead when you also need to stop at an upper-bound cursor (endAtId), which this endpoint does not accept. Both endpoints read the same underlying records.
Preconditions: supply the tenant-id header. Use page and size for offset paging, or pass the startAfterId returned by the previous page to continue from where you left off; omit all three to receive the first default-sized page.
Filtering: the optional filter parameter takes a JSON object encoded as a string, for example {"data.status":{"eq":"COMPLETED"}}, and is applied before pagination. Supported comparison operators are eq, neq, gt, gte, lt, lte, in, nin, and contains. Do not include tenantId in the filter - it is injected automatically from the header.
What you get back: an envelope carrying the matching roster records in data, navigation links, and totalCount when the underlying store reports one. Read-only; no state is mutated. Note: when the upstream data layer fails (including an unparseable filter), this endpoint currently returns 200 with an empty body rather than an error status - treat an empty (non-envelope) body as a retryable failure, not as an empty result set.
Query parameters
Server-side filter as a JSON object string, applied before pagination. Supported operators are eq, neq, gt, gte, lt, lte, in, nin, and contains. tenantId is injected automatically and must not be supplied. Omit to return unfiltered records.
Zero-based page number for offset pagination. Defaults to the first page when omitted.
Number of records per page. Defaults to the server page size when omitted.
Forward cursor: return records positioned after this identifier. Use the last id from the previous page to continue iterating.
Headers
Unique identifier of the tenant whose roster data is being accessed. Obtained from your account configuration; it also scopes every filter applied to the request.
Response
A page of roster records for the tenant, with pagination links and a total count when available.