Pagination - Contractors Cloud API

List endpoints return results one page at a time. Each list response wraps the current page of records in a data array alongside metadata describing the full result set.

Page parameters

Control pagination with two query parameters:

Parameter	Type	Description
`page[number]`	integer	The 1-indexed page to retrieve. Defaults to `1`.
`page[size]`	integer	The number of records per page. Defaults to `30`, with a maximum of `100`.

curl "https://api.contractorscloud.com/api/v1/users?page[number]=2&page[size]=50" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Response shape

A paginated response returns the current page of records in data and pagination metadata at the top level:

{
  "data": [
    { "id": 1159, "first_name": "Jane", "last_name": "Doe" }
  ],
  "current_page": 2,
  "per_page": 50,
  "from": 51,
  "to": 100,
  "last_page": 4,
  "total": 197,
  "path": "https://api.contractorscloud.com/api/v1/users",
  "first_page_url": "https://api.contractorscloud.com/api/v1/users?page[number]=1",
  "prev_page_url": "https://api.contractorscloud.com/api/v1/users?page[number]=1",
  "next_page_url": "https://api.contractorscloud.com/api/v1/users?page[number]=3",
  "last_page_url": "https://api.contractorscloud.com/api/v1/users?page[number]=4",
  "links": []
}

Field	Description
`current_page`	The page number of the current response.
`per_page`	The number of records requested per page.
`from` / `to`	The 1-indexed range of records included in `data`. Both are `null` when the page is empty.
`last_page`	The number of the final page.
`total`	The total number of records across all pages.
`next_page_url` / `prev_page_url`	URLs for the adjacent pages, or `null` at the boundaries.
`first_page_url` / `last_page_url`	URLs for the first and last pages.
`path`	The endpoint URL without query parameters.
`links`	Rendered pagination links (previous, numbered pages, next).

Iterating through pages

To walk an entire collection, request the first page and keep following next_page_url until it is null. Alternatively, increment page[number] until current_page equals last_page.

Combine pagination with filtering and sorting to keep result sets small and predictably ordered as you page through them.