Skip to Content
API reference

Authentication

Authenticate requests and manage organization API keys.

Every request to an authenticated API endpoint requires an API key in the X-API-Key header. The key determines the organization; requests cannot choose another organization by passing an ID.

GET /api/v1/organization HTTP/1.1
Host: your-app.example
X-API-Key: api_your_generated_key

The header name is case-insensitive. Dashboard session cookies and an Authorization: Bearer header do not replace X-API-Key.

Create and manage keys

Owners and admins can manage keys for the active organization under Settings → Firm Settings → API → API keys. Ordinary members cannot list, create, update, or revoke keys.

ActionBehavior
CreateEnter a description of 1–70 characters and an optional expiry. The secret is shown once.
ListView descriptions, expiration times, and last-use times.
EditChange a description or expiry. The secret remains unchanged.
RevokePermanently delete a key. Subsequent requests using it return 401.

Keys use api_ followed by 32 hexadecimal characters. If you lose a key, create a replacement.

Expiration

The expiry picker uses your local time and saves an exact timestamp. A key is invalid at or after that timestamp. Leave the field empty for a key that never expires. New expiry values must be in the future.

A key's last-use timestamp is recorded when it successfully authenticates a request.

Rotate a key

  1. Create a replacement key in the same organization.
  2. Update your integration's server environment or secret manager.
  3. Confirm that the integration can fetch its organization using the new key.
  4. Revoke the old key.

If a key has been exposed, revoke it and replace it in the affected integration.

Browser requests

Prefer calling the API from your backend so the secret stays on your server. The application's CORS configuration permits the X-API-Key header for its configured allowed origins. Requests from other browser origins are subject to the browser's CORS checks.

Read-only directory access is available through the member endpoints.

Owners and admins can grant Read only or Read and write independently for leads and clients. Both permissions default to No access, including for keys created before the CRM endpoints were added. Editing a key's permissions takes effect with its existing secret.

Continue with Get organization or authentication troubleshooting.

On this page