Pagination

GET endpoints that return a list are paginated. Control the page and page size with the page and limit query parameters.

Name	Definition
page	The page to return (1-based). Defaults to 1.
limit	Number of items per page. Defaults to 10; maximum 100.

Note

List endpoints also accept resource-specific filters. For example, customers support search, isActive and identificationType.

Example Request

  curl --request GET \
    --url 'https://api.staging.pipevest.com/v1/customers?page=1&limit=10' \
    --header 'Authorization: Bearer <access-token>' \
    --header 'x-client-id: <client-id>'

The response wraps the results in data and returns a pagination object:

{
  "data": [
    { "id": "clx0a1b2c3d4e5f6g7h8i9j0k", "firstName": "John", "lastName": "Doe", "isActive": true }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "totalPages": 5
  }
}

Pagination object

Name	Definition
page	The page that was returned
limit	The page size used for this request
total	Total number of items matching the query
totalPages	Total number of pages (ceil(total / limit))