page and the page size with limit. The pagination fields in the response, and the defaults, differ from endpoint to endpoint, so read the endpoint page before you write a paging loop.| Parameter | Default | Description |
|---|---|---|
page | 1 | 1-based page number. |
limit | 10 | Number of items per page. Many endpoints set their own default. |
POST /domains) also accept them in the body. If a value is present in both places, the query string wins.page below 1, a negative limit, or a value that is not a number returns 400 with the message Invalid pagination parameters. Endpoints can add stricter rules and return 422.limit as at least 1. A limit of 0 passes the shared check, but several endpoints then substitute their own default instead of returning an empty page.limit (for example 100), stay within it. Behaviour above the maximum is not guaranteed to be the same on every endpoint.data, next to the array of items:{
"status": 200,
"message": "Domains fetched successfully",
"data": {
"totalSearchedCount": 42,
"currentPage": 1,
"nextPage": 2,
"totalPages": 5,
"domains": []
}
}| Field | Description |
|---|---|
totalSearchedCount | Number of items that match your filters, across all pages. |
currentPage | The page returned. |
nextPage | The next page number. It is not clamped to totalPages, so it can point past the last page. Do not use it as an end-of-list signal. |
totalPages | Total number of pages for the current limit. |
pagination object:| Endpoint | Default limit | Maximum limit | Where the total is |
|---|---|---|---|
| List Domains | 10 | None stated | data.totalSearchedCount |
| List Mailboxes | 10 | None stated | data.totalSearchedCount (pages count domains, not mailboxes) |
| List Subscriptions | 10 | None stated | data.totalSearchedCount, and data.totalUnfilteredCount |
| List Workspaces | 10 | None stated | data.totalSearchedCount |
| List Workspace Members | 10 | None stated | data.totalSearchedCount |
| Search Available Domains | 50 | None stated | data.pagination.total |
| List Aged Domains | 20 | 100 | data.pagination.totalCount |
| List Pre-Warmed Domains | 10 | None stated | data.total |
| List Pre-Warmed Subscriptions | 10 | None stated | data.total |
| List ZapShield Allocated Domains | 50 | 100 | data.totalSearchedCount |
| List Deliverability Test Orders | 10 | 100 | data.pagination.totalSearchedCount |
| List Zapbox Connected Accounts | 50 | 100 | pagination.totalCount at the top level of the response |
| Search Zapbox Emails | 50 | 100 | No total. The response is a plain array. |
GET /webhooks/deliveries | 10 | None stated | data.total only |
GET /webhooks/endpoints is not paginated.GET /workspaces/invitations accepts page and limit but returns every invitation regardless.limit even when more pages follow. Stop on totalPages, not on a short page.currentPage reaches totalPages. This example reads every domain with List Domains, which takes page and limit in the JSON body.limit.