Base URL
/v1. If your organization has its own installation, use the URL you were given.
Sending the key
Every/v1 path requires an API key. Send it in either of these headers:
What each key can see
A key of a person with the
viewer role, or an organization key marked read_only, only reads: it can run every GET
and the POST requests that save nothing. See Accounts and organizations.
Optional headers
The case you are working on (
case_…). Queries that carry it are recorded in the case’s chain of custody, and labels
you add count only inside that case. If it names a case you cannot see, the response is 400 with
error: "case_unavailable" and the query is not run.