Connectivity API
API connectivity and key check
Returns the organization the key belongs to, whether it is a live or test key, the key's name, every scope it holds, and when it expires. Call it with a GET request to /ping, authenticated with a restricted API key.
Returns the organization the key belongs to, whether it is a live or test key, the key's name, every scope it holds, and when it expires. Use it to verify a key before integrating, and to check that the key has the scopes the endpoints you plan to call require: a missing scope shows up here as an absent entry in `scopes` instead of as a 403 later. Requests count toward your per-API-key rate limit; sustained overruns return 429 with the standard error envelope.
Authentication and scopes
Authenticate with a restricted API key in the Authorization: Bearer <key> header. No additional scope is required.
Response fields
Fields returned in the 200 response body. Nested objects are listed under their parent. A field marked optional may be absent from the body; one marked nullable is always present but its value may be null.
| Field | Type | Description |
|---|---|---|
ok | boolean | Always true when the request succeeds. |
organization_id | string | Organization ID associated with the API key. |
environment | live | test | Which data the key reaches: `live` keys read and write live data, `test` keys are sandboxed. Derived from the key's environment, so a key created as a test key reports `test` in every deployment. |
key_name | string | The name the key was given when it was created (for example `CLI on my-laptop`). |
scopes | string[] | Every scope the key holds. Compare against the scopes an endpoint requires before calling it. |
expires_at | string nullable | When the key stops working, as an ISO 8601 timestamp, or null when the key does not expire. |
Error codes
Errors return the standard error envelope with a code, message, and a correlationId you can quote to support.
| Status | When it happens |
|---|---|
401 | Missing or invalid API key. Send your key as Authorization: Bearer YOUR_API_KEY. |
429 | Rate limit or plan quota exceeded. Slow down and retry after the current window resets. |
Rate limits and retries
Rate limit or plan quota exceeded. Slow down and retry after the current window resets.