Pagination
Overview
Many list APIs support cursor-based pagination through the optional pageInfo argument.
When used, the API returns a pageInfo object in the payload so you can request the next page.
PageInfoInput (request)
Use this input in supported list operations:
pageInfo: PageInfoInput| Attribute | Type | Description |
|---|---|---|
limit | number | The limit of the results (number of items per page, default is 100). |
cursor | timestamp | The cursor to the next page. It is used to fetch the next page. |
query | string | The query to filter the results. |
count | boolean | Whether to return the total count of the results. |
PageInfo (response)
Supported payloads return a pageInfo object with:
| Attribute | Type | Description |
|---|---|---|
hasNextPage | boolean | Indicates if there are more pages to fetch. |
endCursor | timestamp | The cursor to the next page. Pass it back in |
count | number | The total count of the results (when requested). |
Example request
query convs($input: ConvsInput!, $pageInfo: PageInfoInput) {
convs(input: $input, pageInfo: $pageInfo) {
nodes {
id
createdAt
}
pageInfo {
hasNextPage
endCursor
count
}
}
}{
"input": {
"workspaceId": 12
},
"pageInfo": {
"limit": 25,
"cursor": "2026-03-17T00:00:00.000Z",
"count": true
}
}Example response
{
"data": {
"convs": {
"nodes": [
{ "id": "67d7f55f7a9a4e1d76f58831", "createdAt": "2026-03-16T12:25:10.000Z" }
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "2026-03-16T12:25:10.000Z",
"count": 124
}
}
}
}You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.