API documentation

Authentication

Every request is made with an API key. The key determines its firm, its scopes and which products it can reach.

Where to get a key

Create a key in the Intelligence panel under Organisation → API keys. The full value is shown only once at creation; store it somewhere safe.

Grant a key only the scopes it needs. A restricted key (limited to certain protection resource groups) sees only those groups’ data.

Invalid keys

A missing, malformed, expired or revoked key returns 401. Verify that a key works and which products are enabled with GET /v1/me.

Was this page helpful?