Pagination

The API uses cursor-based pagination to efficiently handle large datasets for endpoints that return multiple items. Cursor pagination provides better performance than offset-based pagination, especially for large datasets.

Query Parameters

Parameter	Type	Default	Description
`page[size]`	integer	30	Number of items per page (max 100)
`page[cursor]`	string	-	Cursor token for retrieving the next/previous page

Response Format

Paginated responses follow the JSON:API specification and include three main sections:

{
    "data": [
        // Array of resource items
    ],
    "meta": {
        "path": "https://api.aspect.systems/v1/examples",
        "per_page": 30,
        "next_cursor": "eyJpZCI6MTUwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": null
    },
    "links": {
        "first": "https://api.aspect.systems/v1/examples?page%5Bsize%5D=30",
        "prev": null,
        "next": "https://api.aspect.systems/v1/examples?page%5Bcursor%5D=eyJpZCI6MTUwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9&page%5Bsize%5D=30"
    }
}

Usage Examples

First page (default size):

GET /v1/examples

First page with custom size:

GET /v1/examples?page[size]=50

Next page using cursor:

GET /v1/examples?page[cursor]=eyJpZCI6MTUwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9&page[size]=30

To navigate through paginated results:

First page: Make a request without the page[cursor] parameter
Subsequent pages: Use the next_cursor value from the meta section, or use the next URL from the links section
Previous pages: Use the prev_cursor value from the meta section, or use the prev URL from the links section

Recommended approach: Use the URLs provided in the links section for navigation, as they include all necessary parameters and proper encoding.

Get Started

Concepts

Guides

Query Parameters

Response Format

Usage Examples

Navigation

​Query Parameters

​Response Format

​Usage Examples

​Navigation

Query Parameters

Response Format

Usage Examples

Navigation