Pagination, filtering, and sorting

Many list endpoints use cursor pagination.

Pagination parameters

page[size]=20
page[after]=<cursor>

Example:

curl -s "$MIO_BASE_URL/api/v1/teams/$TEAM_ID/contacts?page[size]=20" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/vnd.api+json" | jq

Use links.next when present:

{
  "links": {
    "self": "/api/v1/teams/team_123/contacts?page[size]=20",
    "next": "/api/v1/teams/team_123/contacts?page[size]=20&page[after]=0197..."
  },
  "meta": {
    "has_more": true
  }
}

Filters

Filter syntax uses bracketed keys when an endpoint supports it:

filter[email]=member@example.com
filter[status]=active

Sorting

Sort syntax varies by endpoint during the alpha period. The common shape is:

sort=created_at
sort=-created_at

Use - for descending order.

Pagination, filtering, and sorting are not fully uniform across every module yet. Check the generated endpoint page for the exact query parameters accepted by each endpoint.

Conventions

Endpoints

Appendix

Pagination, filtering, and sorting

Filters

Sorting

​Pagination parameters

​Filters

​Sorting

Pagination parameters

Filters

Sorting