Pagination

All list endpoints in the Warp API support cursor-based pagination. These endpoints share a common structure and accept the limit, afterId, and beforeId parameters.

Our client libraries offer auto-pagination helpers to easily traverse all pages of a list.

Response Format

List endpoints return a response with a data array and a hasMore boolean indicating whether additional results are available.

{
  "hasMore": true,
  "data": [
    { "id": "wrk_abc123", ... },
    { "id": "wrk_def456", ... }
  ]
}

Field	Type	Description
hasMore	boolean	true if there are more results available beyond this page
data	array	Array of resource objects

Parameters

limit

• Optional, default is 25
• Specifies the number of objects to return, ranging between 1 and 100

afterId

• Optional, object ID
• A cursor for forward pagination. afterId is an object ID that defines your place in the list. For example, if you make a list request and receive 25 objects ending with wrk_foo, your subsequent call can include afterId=wrk_foo to fetch the next page of the list.

beforeId

• Optional, object ID
• A cursor for backward pagination. beforeId is an object ID that defines your place in the list. For example, if you make a list request and receive 25 objects starting with wrk_bar, your subsequent call can include beforeId=wrk_bar to fetch the previous page of the list.

afterId and beforeId are mutually exclusive. You can use either parameter, but not both simultaneously.

Example

Fetch the first page of workers:

curl https://api.warp.dev/v1/workers?limit=10 \
  -H "x-api-key: wrp_company_your_api_key"

Response:

{
  "hasMore": true,
  "data": [
    { "id": "wrk_abc123", "name": "Alice Smith" },
    { "id": "wrk_def456", "name": "Bob Jones" },
    ...
    { "id": "wrk_xyz789", "name": "Carol White" }
  ]
}

Fetch the next page using afterId:

curl https://api.warp.dev/v1/workers?limit=10&afterId=wrk_xyz789 \
  -H "x-api-key: wrp_company_your_api_key"