The API can return a large number of objects in response to a query. To limit the number of objects returned, an offset-based pagination mechanism is used.
For pagination within collections, the limit and offset parameters are used in the query string. The API returns a wrapper over a collection with the following fields:
type string | list |
data array | Array of items |
size integer | The total size of the collection |
offset integer | The offset from the beginning of the collection |
limit integer | The limit on returned items |
nextLink string | The link to the next page of the collection |
prevLink string | The link to the previous page of the collection |
The maximum limit is 100 items.
curl --request GET \
--url https://api.miro.com/v1/teams/<id>/boards?limit=2&fields=name
{
"type": "list",
"limit": 2,
"offset": 0,
"size": 3,
"nextLink": "https://api.miro.com/teams/3074457345710988606/boards?limit=2&offset=2",
"prevLink": null,
"data": [
{
"type": "board",
"name": "Marketing Research",
"id": "o9J_k0jX1ps="
},
{
"type": "board",
"name": "Untitled",
"id": "o9J_k0jX30s="
}
]
}
The returned number of objects in the collection can be less than the requested one, even if
offset
+limit
has not reached the valuesize
.
In case a link to the next page is needed, you need to add the fields offset and limit from the response. If offset + limit >= size, this means that all collection objects are received.
Since the collection can change between requests, sometimes the final number of objects received can differ from the size field.