Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

RosterRecord

List roster rows with offset pagination and totals

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, 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.

get/roster-records/{rosterId}/paged

Path parameters

rosterIdstring required

Identifier of the roster job to operate on, as returned by the roster listing endpoints.

Query parameters

pageinteger

Zero-based page number. Defaults to 0.

sizeinteger

Maximum number of rows to return. Defaults to 50; values above 1000 are capped at 1000.

statusesstring

Comma-separated list of row states to include. Meaningful values are PENDING, IN_PROGRESS, VALIDATION_IN_PROGRESS, PRE_PROCESSING, VALIDATION_FAILED, VALIDATED, COMPLETED, FAILED, and CANCELLED. Values are not validated - an unknown value is not rejected, it simply matches no rows. Omit to include rows in every state.

Headers

tenant-idstring required

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

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

pageinteger

Zero-based number of the page returned.

sizeinteger

Number of rows requested per page. Defaults to 50 and is capped at 1000.

totalCountinteger

Total rows matching the request across every page, after any status filter is applied.

totalPagesinteger

Total number of pages available at the current page size.

hasMoreboolean

True when more pages remain after this one.

Example response

{
  "data": [
    {
      "rowId": "a1b2c3d4e5f60718",
      "status": "VALIDATION_FAILED",
      "createdAt": "2026-07-14T09:12:33Z",
      "updatedAt": "2026-07-14T09:18:02Z"
    }
  ],
  "size": 50,
  "totalCount": 128,
  "totalPages": 3
}