> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/client-approvals/openapi.json](/docs/api/client-approvals/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Client approvals

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

Items your clients approve before they go out.

Campaigns. 4 endpoints under `https://api.ken.so`. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`: see [Authentication](/docs/authentication.md), [Workspaces](/docs/workspaces.md) and [Errors](/docs/errors.md). OpenAPI for this resource only: [/docs/api/client-approvals/openapi.json](/docs/api/client-approvals/openapi.json).

- `GET /v1/client-approvals/items` - List approval items (`client-approvals.list-items`): [/docs/api/client-approvals/list-items.md](/docs/api/client-approvals/list-items.md)
- `GET /v1/client-approvals/items/{itemId}` - Get an approval item (`client-approvals.get-item`): [/docs/api/client-approvals/get-item.md](/docs/api/client-approvals/get-item.md)
- `GET /v1/client-approvals/settings` - Get approval settings (`client-approvals.get-settings`): [/docs/api/client-approvals/get-settings.md](/docs/api/client-approvals/get-settings.md)
- `GET /v1/client-approvals/events` - List approval events (`client-approvals.list-events`): [/docs/api/client-approvals/list-events.md](/docs/api/client-approvals/list-events.md)

## List approval items

`GET /v1/client-approvals/items` - operationId `client-approvals.list-items`

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 12,000 requests a minute per API key |

Lists the workspace's approval items, newest first. Filter with `status`, `kind` and
`campaignId`, and page with `limit` and `cursor`.

The list holds only the kinds whose page you can view: replies need Inbox, copy, lead lists and campaign
batches need Campaigns, and orders need Delivery. A `kind` you cannot read gives an empty list. Items
that belong to a share link are not listed here: read them through the share.

Errors:

- `400 validation_failed`: `status`, `kind`, `limit` or `cursor` is invalid.

Open to any workspace member.

Needs the `client_approvals` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/client-approvals/GET/v1/client-approvals/items)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `status` | query | string | no | Only items in this status: `pending`, `approved`, `changes_requested`, `superseded` or `cancelled`. |
| `kind` | query | string | no | Only items of this kind: `copy`, `lead_list`, `reply`, `order` or `campaign_batch`. |
| `campaignId` | query | integer (int64) | no | Only items of this campaign. |
| `limit` | query | integer (int32) | no | Page size, from 1 to 200. Defaults to 50. |
| `cursor` | query | string | no | The `nextCursor` from the previous page. Omit it for the first page. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a list of `ClientApprovalItem`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the item. |
| `kind` | string | What the client reviews: `copy`, `lead_list`, `reply`, `order` or `campaign_batch`. Items that belong to a share can also be `settings`, `icp`, `report` or `account_plan`. |
| `status` | string | Where the item stands: `pending`, `approved`, `changes_requested`, `superseded` (a newer version replaced it) or `cancelled`. |
| `title` | string | Title the client sees. |
| `campaignId` | integer (int64) | Id of the campaign the item belongs to. Null when it has none, such as a domain order. |
| `campaignName` | string | Name of the campaign in `campaignId`. Null when there is none. |
| `subjectId` | integer (int64) | Numeric id of the thing under review, such as a segment, a scheduled reply or a domain order. Null when there is none. |
| `subjectKey` | string | Key of the thing under review, in the form `type:id`: `campaign:12`, `segment:34`, `message:56`, `order:78` or `campaign_batch:90`. |
| `fingerprint` | string | Hash of the content under review. When the content changes, Kenso creates a new item with a new fingerprint. |
| `pausedCampaign` | boolean | True when creating this item paused a sending campaign. |
| `createdByUserId` | integer (int64) | Id of the member whose action created the item. Null when Kenso created it. |
| `createdAt` | string (date-time) | When Kenso created the item, in UTC. |
| `decidedAt` | string (date-time) | When the client approved or requested changes, in UTC. Null while the item is pending. |
| `decidedByName` | string | Name the reviewer gave with the decision. Null while the item is pending. |
| `decisionComment` | string | Comment left with the decision. Null when there is none. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/client-approvals/items?limit=50" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": [
    {
      "id": 812,
      "kind": "copy",
      "status": "string",
      "title": "string",
      "campaignId": 812,
      "campaignName": "string",
      "subjectId": 812,
      "subjectKey": "campaign:12",
      "fingerprint": "string",
      "pausedCampaign": true,
      "createdByUserId": 812,
      "createdAt": "2026-09-23T15:02:11Z",
      "decidedAt": "2026-09-23T15:02:11Z",
      "decidedByName": "string",
      "decisionComment": "string"
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Get an approval item

`GET /v1/client-approvals/items/{itemId}` - operationId `client-approvals.get-item`

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 12,000 requests a minute per API key |

Returns one approval item with the snapshot the client reviews, its comments (oldest first) and its log
(newest first). Kenso freezes the snapshot when it creates the item. Leads the client removes from a lead
list update it.

Errors:

- `404 not_found`: no item with this id exists in this workspace, or you cannot view its page. Replies
need Inbox, copy, lead lists and campaign batches need Campaigns, orders need Delivery, and share items
need Share.

Open to any workspace member.

Needs the `client_approvals` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/client-approvals/GET/v1/client-approvals/items/%7BitemId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `itemId` | path | integer (int64) | yes | Id of the approval item. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `ClientApprovalItemDetail`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the item. |
| `kind` | string | What the client reviews: `copy`, `lead_list`, `reply`, `order` or `campaign_batch`. Items that belong to a share can also be `settings`, `icp`, `report` or `account_plan`. |
| `status` | string | Where the item stands: `pending`, `approved`, `changes_requested`, `superseded` (a newer version replaced it) or `cancelled`. |
| `title` | string | Title the client sees. |
| `campaignId` | integer (int64) | Id of the campaign the item belongs to. Null when it has none, such as a domain order. |
| `campaignName` | string | Name of the campaign in `campaignId`. Null when there is none. |
| `subjectId` | integer (int64) | Numeric id of the thing under review, such as a segment, a scheduled reply or a domain order. Null when there is none. |
| `subjectKey` | string | Key of the thing under review, in the form `type:id`: `campaign:12`, `segment:34`, `message:56`, `order:78` or `campaign_batch:90`. |
| `fingerprint` | string | Hash of the content under review. When the content changes, Kenso creates a new item with a new fingerprint. |
| `pausedCampaign` | boolean | True when creating this item paused a sending campaign. |
| `createdByUserId` | integer (int64) | Id of the member whose action created the item. Null when Kenso created it. |
| `createdAt` | string (date-time) | When Kenso created the item, in UTC. |
| `decidedAt` | string (date-time) | When the client approved or requested changes, in UTC. Null while the item is pending. |
| `decidedByName` | string | Name the reviewer gave with the decision. Null while the item is pending. |
| `decisionComment` | string | Comment left with the decision. Null when there is none. |
| `snapshot` | object | What the client reviews, as a JSON object that Kenso froze when it created the item. Its shape depends on `kind`. Leads the client removes from a lead list update it. |
| `comments` | array of ClientApprovalComment | Comments on the item, oldest first. |
| `events` | array of ClientApprovalEvent | The item's log, newest first. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/client-approvals/items/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "kind": "copy",
    "status": "string",
    "title": "string",
    "campaignId": 812,
    "campaignName": "string",
    "subjectId": 812,
    "subjectKey": "campaign:12",
    "fingerprint": "string",
    "pausedCampaign": true,
    "createdByUserId": 812,
    "createdAt": "2026-09-23T15:02:11Z",
    "decidedAt": "2026-09-23T15:02:11Z",
    "decidedByName": "string",
    "decisionComment": "string",
    "snapshot": null,
    "comments": [
      {
        "id": 812,
        "anchor": "string",
        "body": "string",
        "authorName": "string",
        "createdAt": "2026-09-23T15:02:11Z"
      }
    ],
    "events": [
      {
        "id": 812,
        "itemId": 812,
        "eventType": "item_created",
        "actorKind": "string",
        "actorName": "string",
        "actorUserId": 812,
        "data": null,
        "createdAt": "2026-09-23T15:02:11Z"
      }
    ]
  }
}
```

## Get approval settings

`GET /v1/client-approvals/settings` - operationId `client-approvals.get-settings`

| Permission | Rate limit |
| --- | --- |
| The `workspace_settings` permission | 12,000 requests a minute per API key |

Returns the workspace's external approval settings: the rule for each kind, the extra addresses that get
reminder emails, the reminder time zone, the portal link, and the number of items waiting for a decision.
The first read creates the settings and the portal link.

Anyone who has `portalUrl` can approve for your client, so keep it private.

Requires the `workspace_settings` permission.

Needs the `client_approvals` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/client-approvals/GET/v1/client-approvals/settings)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `ClientApprovalSettings`.

| Field | Type | Description |
| --- | --- | --- |
| `rules` | ClientApprovalRules | Whether each kind of item waits for the client's approval. |
| `reminderEmails` | array of string | Extra email addresses that get an email when an item starts waiting, and the reminders after that. |
| `timeZone` | string | IANA time zone Kenso uses to time the reminder emails, such as `Europe/Berlin`. Defaults to the newest campaign's sending time zone, else UTC. |
| `portalUrl` | string | The portal link for your client. It needs no login and does not expire, so anyone who has it can approve. |
| `portalTokenRotatedAt` | string (date-time) | When the portal link was last replaced, in UTC. Null when it never was. |
| `approvalLinksEnabled` | boolean | True when external approval links are on. The switch is in the white-label settings of the workspace that manages this one. While it is off, every rule acts as `auto`. |
| `pendingCount` | integer (int32) | Number of items waiting for the client's decision. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/client-approvals/settings" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "rules": {
      "copy": "string",
      "leadList": "string",
      "reply": "string",
      "order": "string"
    },
    "reminderEmails": [
      "jane@example.com"
    ],
    "timeZone": "Europe/Berlin",
    "portalUrl": "https://example.com",
    "portalTokenRotatedAt": "2026-09-23T15:02:11Z",
    "approvalLinksEnabled": true,
    "pendingCount": 1
  }
}
```

## List approval events

`GET /v1/client-approvals/events` - operationId `client-approvals.list-events`

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 12,000 requests a minute per API key |

Lists the approval log, newest first: items created, decisions, comments, lead removals and restores,
reminders, link rotations, rule changes, campaign pauses and resumes, submitted campaign reviews and share
link activity. Filter to one item with `itemId`, read older events with `before`, and page with
`limit` and `cursor`.

The log leaves out the events of items whose page you cannot view, as the item list does. Share link events
need Share, and campaign review events need Campaigns.

Errors:

- `400 validation_failed`: `limit` is not from 1 to 200, or `cursor` is invalid.

Open to any workspace member.

Needs the `client_approvals` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/client-approvals/GET/v1/client-approvals/events)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `itemId` | query | integer (int64) | no | Only the entries of this approval item. |
| `before` | query | string (date-time) | no | Only entries before this time, as an ISO 8601 timestamp. The bound is exclusive, and a `cursor` replaces it. |
| `limit` | query | integer (int32) | no | Page size, from 1 to 200. Defaults to 50. |
| `cursor` | query | string | no | The `nextCursor` from the previous page. Omit it for the first page. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a list of `ClientApprovalEvent`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the entry. |
| `itemId` | integer (int64) | Id of the item the entry is about. Null for an entry about the whole workspace, such as a rules change. |
| `eventType` | string | What happened: `item_created`, `approved`, `changes_requested`, `commented`, `lead_removed`, `lead_restored`, `superseded`, `cancelled`, `reminder_sent`, `link_rotated`, `rules_changed`, `campaign_paused`, `campaign_resumed`, `classic_review_submitted`, `share_created`, `share_viewed`, `share_reminder_sent`, `share_submitted`, `share_revoked`, `report_sent`, `decision_undone` or `snapshot_refreshed`. Kenso may add new types, so handle unknown values. |
| `actorKind` | string | Who acted: `reviewer` (the client, through a link), `user` (a workspace member) or `system` (Kenso). |
| `actorName` | string | Name of the person who acted, when known. |
| `actorUserId` | integer (int64) | Id of the member who acted. Null unless `actorKind` is `user`. |
| `data` | object | Details of the entry as a JSON object. Its keys depend on `eventType`. Null when there are none. |
| `createdAt` | string (date-time) | When it happened, in UTC. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/client-approvals/events?limit=50" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": [
    {
      "id": 812,
      "itemId": 812,
      "eventType": "item_created",
      "actorKind": "string",
      "actorName": "string",
      "actorUserId": 812,
      "data": null,
      "createdAt": "2026-09-23T15:02:11Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### ClientApprovalComment

A comment a reviewer left on an approval item.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer (int64) | no | Id of the comment. |
| `anchor` | string | no | The step, variant or paragraph the comment points at. Null when it is about the whole item. |
| `body` | string | no | Text of the comment. |
| `authorName` | string | no | Name the reviewer gave. |
| `createdAt` | string (date-time) | no | When the comment was left, in UTC. |

### ClientApprovalEvent

One entry in the approval log.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer (int64) | no | Id of the entry. |
| `itemId` | integer (int64) | no | Id of the item the entry is about. Null for an entry about the whole workspace, such as a rules change. |
| `eventType` | string | no | What happened: `item_created`, `approved`, `changes_requested`, `commented`, `lead_removed`, `lead_restored`, `superseded`, `cancelled`, `reminder_sent`, `link_rotated`, `rules_changed`, `campaign_paused`, `campaign_resumed`, `classic_review_submitted`, `share_created`, `share_viewed`, `share_reminder_sent`, `share_submitted`, `share_revoked`, `report_sent`, `decision_undone` or `snapshot_refreshed`. Kenso may add new types, so handle unknown values. |
| `actorKind` | string | no | Who acted: `reviewer` (the client, through a link), `user` (a workspace member) or `system` (Kenso). |
| `actorName` | string | no | Name of the person who acted, when known. |
| `actorUserId` | integer (int64) | no | Id of the member who acted. Null unless `actorKind` is `user`. |
| `data` | object | no | Details of the entry as a JSON object. Its keys depend on `eventType`. Null when there are none. |
| `createdAt` | string (date-time) | no | When it happened, in UTC. |

### ClientApprovalRules

Whether each kind of item waits for the client's approval.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `copy` | string | no | Rule for campaign copy: `require` (wait for the client) or `auto` (go ahead without approval). |
| `leadList` | string | no | Rule for lead lists: `require` (wait for the client) or `auto` (go ahead without approval). |
| `reply` | string | no | Rule for replies: `require` (wait for the client) or `auto` (go ahead without approval). |
| `order` | string | no | Rule for domain orders: `require` (wait for the client) or `auto` (go ahead without approval). |

All resources: [/docs.md](/docs.md).
