This API is in beta. Endpoints and response shapes may change before stable release.

Pagination

All list endpoints are paginated. Use the page and page_size query parameters to navigate through results.

Parameter Type Required Description
page integer — Page number to return. Defaults to 1.
page_size integer — Number of results per page. Defaults to 50, maximum 200.

Response shape

Every list response returns a data array and a meta object with pagination details.

meta object fields
Field Type Mutability Notes
page integer optional Current page number.
page_size integer optional Number of results per page (as requested, or the default).
total_pages integer optional Total number of pages available.
total_entries integer optional Total number of matching records across all pages.
200 
{
  "data": [
    { "id": "...", ... },
    { "id": "...", ... }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_pages": 4,
    "total_entries": 183
  }
}

Incremental sync

All list endpoints accept an updated_after query parameter. Pass an ISO 8601 timestamp to fetch only records changed since your last sync. Combine with pagination to page through large change sets.

200 GET /api/shed/organisations/:org_id/receipts?updated_after=2026-01-01T00:00:00Z&page=2 
{
  "data": [ ... ],
  "meta": {
    "page": 2,
    "page_size": 50,
    "total_pages": 2,
    "total_entries": 67
  }
}