Klarify API

The Klarify Public API lets you connect process documentation, organizational structure, and membership workflows with external systems. Use scoped API keys to control what each integration can access.

Required permissions

Account Owners, Super Admins, and Account Managers can create and revoke API keys.

Caution

API keys can read or change your organization’s data according to their scopes. Store them in a secrets manager or environment variable, and never commit them to version control.

Prerequisites

• You have the required permissions (see above)

Create an API key

In Klarify’s header bar, open the organization menu, select Account settings, then select API Keys under Org Settings.

1. Click Create API key.
2. Enter a descriptive Name for the integration.
3. Select one or more scopes.
4. Click Create.
5. Click Copy and store the key securely.

The full key is shown only once. Klarify lists its name, obfuscated value, and creation date after you close the modal.

Choose access scopes

Grant only the scopes the integration requires.

Scope	Access
Manage procedures (read & write) (manage:procedures)	Process models, task instructions, folders, and document access
Manage people (read & write) (manage:people)	Regions, locations, departments, teams, positions, and employees
Manage members & invitations (read & write) (manage:members)	Organization members, invitations, roles, content access, and member audit events
Read organization info (read:organization)	Organization details, settings, and aggregate statistics

Country, state, and city reference data is available to any authenticated API key.

Authenticate API requests

Send requests to the versioned API under:

https://integration.klarify.biz/v1

Include the API key as a bearer token in the Authorization header:

curl "https://integration.klarify.biz/v1/organization" \
  --header "Authorization: Bearer YOUR_API_KEY"

The interactive API reference lists every endpoint, request field, response, and required scope.

Manage API keys

The API Keys page lists every active key for your organization.

• Select View settings to review a key’s name and scopes.
• Select Revoke to stop a key from working immediately. Revoked keys cannot be restored.

Migrate a legacy API key

The API Key (Legacy) page contains the older read-only organization key. It passes an access_key in the query string and is deprecated.

Create a scoped key on the API Keys page, update your integration to use the bearer Authorization header, and then stop using the legacy key.