Skip to main content
With your token in hand, let’s make some requests and understand how the API responds.
Create a test operator in the Developer Portal before exploring real operator data. Test operators are the recommended way to try requests safely.

List your sites

Response:
A few things to notice:
  • sites array — resources are wrapped in a key matching the resource name
  • meta.pagination — every list response includes pagination info. Use page and limit query parameters to navigate.
  • IDs are prefixed strings — e.g. site_14b419f1096013f1. Use these when referencing resources in other endpoints.

Fetch a single resource

Fetch a single site by its ID:
Some endpoints support the expand query parameter to include related resources inline. Without expand, related resources appear as IDs. With it, they’re included as full objects.
You can expand multiple relations with a comma-separated list, and nest with dot notation:
Each expanded resource requires the appropriate read scope on your token.

Common patterns

These apply across the entire API. Each is covered in more detail in the dedicated guides.

Pagination

List endpoints return 50 items by default, up to a maximum of 100. Use page and limit to navigate:
Check meta.pagination.pages for the total number of pages and meta.pagination.next for the next page number (null on the last page). See Responses for full details.

Error handling

Errors return a consistent structure with a code for programmatic handling and details for field-level validation messages. See Errors for the full list of error codes.

Idempotency

For any POST request, include an Idempotency-Key header to safely retry without creating duplicates. The API stores the response for 24 hours. See Requests for details.

Rate limits

The API allows 10 requests per second and 60 requests per minute. If you exceed this, you’ll receive a 429 Too Many Requests response. Check the RateLimit-Reset header for when to retry. See Requests for details.