Skip to main content
Every endpoint below is listed with its parameters, example responses, and a Try it button that sends a real request from your browser. For what each data set means and why it’s useful, see the Documentation tab.

​
Base URL

All requests go to:

​
Authentication

Send your API key in the Authorization header on every request:
Each endpoint needs its own scope on the key. See Authentication for how to create a key and choose its scopes.

​
Versions

The version is part of the path. Every endpoint starts with /v1.

​
Requests and responses

  • Every endpoint is a GET and only reads data.
  • Responses are JSON with snake_case field names. A single record comes back as { "data": { ... } }, a list as { "data": [ ... ] }.
  • Lists that can be long return one page at a time with a next_cursor. Pass it back as cursor to get the next page; null means you have them all.
  • Every error has the same shape, { "error": { "type", "message" } }. See Errors.

​
Endpoints