Skip to main content

List roster rows with cursor pagination

GET 
/roster-records/:rosterId

Returns a page of individual data rows belonging to one roster job.

When to use: call this to stream through a large roster without needing to know how many rows there are; use GET /roster-records/{rosterId}/paged instead when you need totalCount and totalPages, for example to render a numbered page selector.

Preconditions: supply the tenant-id header and the rosterId of an existing roster job. Leave cursor unset on the first call, then pass the nextCursor from each response to retrieve the following page; nextCursor is absent once the last page has been reached. size controls how many rows come back and defaults to 50, with values above 1000 capped at 1000.

Filtering: pass statuses to restrict the page to particular row states, as a comma-separated list drawn from PENDING, IN_PROGRESS, VALIDATION_IN_PROGRESS, PRE_PROCESSING, VALIDATION_FAILED, VALIDATED, VALIDATED_WITH_WARNINGS, COMPLETED, FAILED, and CANCELLED; omit it to receive rows in every state.

What you get back: the rows for this page in data, the nextCursor to pass on the following call, the effective pageSize, and hasMore. Each row carries its rowId - the identifier used as recordKey when saving draft edits. Read-only; no state is mutated.

Request​

Responses​

One page of roster rows, with the cursor needed to request the next page.