Pagination

List endpoints return results a page at a time. Control the page with two query parameters:

Parameter	Default	Description
`page`	`1`	The page to return, starting at 1.
`per_page`	`20`	How many results to return on each page.

curl "https://api.staging.streamlinedpayments.com/api/v1/customers?page=2&per_page=50" \
  -H "X-App-Id: $STREAMLINED_APP_ID" \
  -H "X-Api-Key: $STREAMLINED_API_KEY"

Each response includes a meta object alongside the results:

{
  "customers": [ ... ],
  "meta": {
    "current_page": 2,
    "per_page": 50,
    "total_pages": 4,
    "total_count": 183
  }
}

Keep requesting the next page until current_page equals total_pages.

Check the endpoint’s reference page for the parameters it accepts. Some list endpoints also take filters or a sort column, such as sort_col on orders.

⌘I

Get started

Guides