Skip to main content
Most lists in pgw are short and come back whole. Two can grow to thousands of items, so pgw returns them one page at a time:
  • GET /api/v1/bindings, in binding key order
  • GET /api/v1/upstreams/{id}/users, by domain and then username

Read a list one page at a time

A request for a page takes these query parameters.
1

Get the first page

Replace Z--k3D5Qpnr6sFHF3YX2Fw with your upstream’s ID. The page holds the items and a next value.
2

Get the next page

Pass the previous page’s next as after.
3

Stop at the last page

Repeat the previous step until next is empty.
Pass next back unchanged. A limit outside 1 to 1000 gets 400. For users, an after that isn’t the next of a page of users also gets 400, with the error after must be the next of a page of users.

Lists without pages

The other lists return every item in one response, as {"items": [...]}, with no next. GET /api/v1/push-events takes limit, 100 by default, and returns only the newest events. GET /api/v1/register-bans returns {"bans": [...]}.

Next steps

Read the push log

List the newest push events for your tenant.

Handle errors

Read the error body when a request for a page fails.