Consumer, Webhook, AM Employee, AM Equipment Item, HRIS Employee resources have support for bulk retrieval via list APIs. UAPI uses cursor-based pagination via the optional cursor and limit parameters.
To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.next. If meta.next is null you're at the end of the list.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| cursor | String | No | Cursor to start from. You can find cursors for next page in the meta property of the response. |
| limit | Number | No | Number of results to return. |
Response Body
| Name | Type | Description |
|---|---|---|
| meta.next | String | Cursor to navigate to the next page of results through the API |
| meta.current | String | Cursor to navigate to the current page of results through the API |
| meta.itemsOnPage | Number | Number of items returned in the data property of the response |