Skip to main content
GET
List link clearances

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

If-None-Match
string

Optional. The ETag of the answer you already have. When the answer would be the same, the response is 304 without a body.

Query Parameters

active
boolean
default:true

Only clearances that have not ended or been revoked

Response

Clearances

success
boolean
Example:

true

data
object