Platform / Platform

List endpoint pagination

List endpoints return collections of resources. Pagination behavior varies by surface.

01 REST API list endpoints

details

Keyed array responses

Operator list endpoints return arrays wrapped in a keyed object. For example, GET /api/v1/operator/robots returns {"robots": [...]}, GET /api/v1/operator/missions returns {"missions": [...]}. These endpoints are scoped to the authenticated workspace and return the full result set.

02 SCIM 2.0 pagination

details

Parameters

startIndex (1-based, default 1), count (max results per page, default 100), filter (SCIM filter expression e.g. userName eq "user@example.com").

Response envelope

Returns schemas, totalResults, startIndex, itemsPerPage, and Resources array following the SCIM 2.0 ListResponse standard.

03 SCIM list response example

example

json

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 42,
  "startIndex": 1,
  "itemsPerPage": 100,
  "Resources": [
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "userName": "user@example.com",
      "active": true
    }
  ]
}

Related docs