Skip to main content

List roster rows with offset pagination and totals

GET 
/roster-records/:rosterId/paged

Returns a page of individual data rows belonging to one roster job, together with the total number of matching rows.

When to use: call this when the caller needs to show how many rows exist or jump directly to an arbitrary page, such as a numbered page selector in a table; use the cursor-based GET /roster-records/{rosterId} instead when streaming through a large roster, since computing totals costs more.

Preconditions: supply the tenant-id header and the rosterId of an existing roster job. page is zero-based and defaults to 0; size controls rows per page, defaults to 50, and values above 1000 are 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. The totals reflect the filter.

What you get back: the rows for this page in data, the echoed page and size, totalCount and totalPages across the filtered set, and hasMore. Read-only; no state is mutated.

Request​

Responses​

One page of roster rows, with the total row and page counts for the filtered set.