Skip to main content
Every v1 list endpoint pages the same way, with an opaque page token.
  1. Set the page size with page_size.
  2. Read next_page_token from the response.
  3. Send that value as page_token to get the next page.
  4. Stop when next_page_token is missing or null.
Fetch the first page
Response
Fetch the next page

​
Page tokens

A page token is opaque. Don’t decode it, build one by hand, or infer meaning from it. An empty, malformed, or altered page token returns 400, with code set to pagination.invalid_page_token. The request doesn’t silently restart at the first page. To get the first page, omit page_token. A page token works only with the endpoint and filters that produced it. Keep page_size and every filter the same on every request until you reach the last page.

​
Short and empty pages

A page can contain fewer items than your page_size, even when more items remain. A page can even be empty while next_page_token is still set. Several endpoints do this, including List Workflows, List Workflow Steps, and List Identity Events. Stop only when next_page_token is missing or null, never on a short or empty page.

​
Maximum page size

The maximum page_size varies by endpoint. If you send a page_size above the endpoint’s maximum, Lumos uses the maximum instead of rejecting the request. A successful call doesn’t tell you the maximum. To find the exact maximum and default, read the page_size parameter in the reference for the endpoint you call.