Generate an API key

The Integration API provides read-only access to your organization’s procedures, processes, subprocesses, and tasks. Use it to integrate Klarify data into external dashboards, reporting tools, or workflow systems.

Required permissions

Account Owners, Super Admins, and Account Managers can generate API keys.

Caution

API keys provide access to your organization’s process data. Never commit them to version control or share them publicly.

Prerequisites

• You have the required permissions (see above)

Generate your access key

1. Click your profile icon in the top-right corner.
2. Select Settings.
3. Click Integrations in the left sidebar.
4. Click Generate Key.
5. Copy the key immediately — it is only displayed once.

Store the key in a password manager or environment variable, not in source code.

Note

Regenerating a key immediately invalidates the previous one. Update all systems using the old key before regenerating.

API endpoint

GET https://integration.klarify.biz/api/procedures

All responses are JSON.

Query parameters

Parameter	Required	Default	Description
access_key	Yes	—	Your organization API key
page	No	0	Zero-based page number
pageSize	No	100	Items per page (max 100 recommended)
sort	No	—	Format: field,direction (e.g. updated_at,desc, name,asc)
last_updated_at	No	—	ISO 8601 timestamp — returns only items modified after this time

Response structure

{
  "data": [
    {
      "id": 12345,
      "name": "Customer Onboarding Process",
      "type": "PROCESS_MODEL",
      "status": "PUBLISHED",
      "url": "https://yourorg.klarify.biz/document/12345",
      "owner": {
        "id": 678,
        "job_title": "Customer Success Manager"
      },
      "updated_at": "2024-01-15T14:30:00Z",
      "first_published_at": "2024-01-10T09:00:00Z",
      "lanes": [
        {
          "id": "Lane_1",
          "name": "Customer Service",
          "nestedLanes": []
        }
      ],
      "called_within": [],
      "called_from": [
        {
          "id": 12100,
          "name": "Sales Pipeline",
          "type": "PROCESS_MODEL",
          "status": "PUBLISHED",
          "url": "https://yourorg.klarify.biz/document/12100",
          "updated_at": "2024-01-12T11:00:00Z",
          "first_published_at": "2024-01-08T09:00:00Z"
        }
      ]
    }
  ],
  "hasNext": true
}

Field	Type	Description
id	integer	Unique identifier for the procedure
name	string	Display name
type	string	One of PROCESS_MODEL, TASK_INSTRUCTIONS, SUBPROCESS, or TASK
status	string	Publication state — DRAFT, EDITED, or PUBLISHED
url	string	Direct link to view the document in Klarify
owner	object | null	The position accountable for the document, as { id, job_title }
updated_at	string	ISO 8601 timestamp of last modification (or last publish, when available)
first_published_at	string | null	ISO 8601 timestamp of the first publish
lanes	array	Lanes in the BPMN diagram, each as { id, name, nestedLanes }
called_within	array	Child procedures called from inside this one
called_from	array	Procedures that call this one
hasNext	boolean	true if more pages are available

Each entry in called_within and called_from is a procedure summary with id, name, type, status, url, updated_at, and first_published_at.

Example requests

# Get first page of procedures
curl "https://integration.klarify.biz/api/procedures?access_key=YOUR_KEY"

# Page 3, sorted by last update
curl "https://integration.klarify.biz/api/procedures?access_key=YOUR_KEY&page=2&sort=updated_at,desc"

# Incremental sync — only items updated since a specific time
curl "https://integration.klarify.biz/api/procedures?access_key=YOUR_KEY&last_updated_at=2024-01-15T10:30:00Z"

Error responses

Status	Meaning	Cause
404	Invalid access key	Key is incorrect, was regenerated, or doesn’t exist
500	Missing access key	The access_key parameter was not included in the request

Contact Klarify support at support@klarify.biz for API assistance.