Skip to main content

Request and Response Structure

Pagination

All collection endpoints support cursor-style pagination via limit & page query parameters. For example: ?limit=25&page=2.

Filtering & Sorting

  • Date range: minimumUpdatedDate, maximumUpdatedDate
  • Status filters: e.g. statusBucket[]=PENDING&statusBucket[]=CONFIRMED
  • Sorting: sortBy + sortDirection

Response Envelope

Successful responses for collection endpoints share a common structure:
{
  "data": [ /* array of resources */ ],
  "totalCount": 100 // total resources count
}

Error Handling

CodeMeaningRetry?
400Validation / bad input
401Invalid API credentials
404Resource not found
429Rate limited
500Server error