How to use the API

  • All endpoints accept and return JSON.
  • Authenticate using your API key as a query parameter: ?api_key=YOUR_KEY
  • The fields returned are determined by your organization's API configuration and may therefore vary.

Pagination

Paginated endpoints return the following headers:

  • X-Pagination-Total-Count - Total number of items across all pages
  • X-Pagination-Page-Count - Total number of pages available
  • X-Pagination-Current-Page - Current page number
  • X-Pagination-Per-Page - Number of items per page
  • Link - Navigation links for self, first, last, prev, and next pages