Client approvals
Items your clients approve before they go out.
Headers
The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Ken-Version | header | string, one of: 2026-11-02, 1.1 | optional | 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 date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy. |
X-Ken-Workspace-Id | header | integer (int64) | optional | 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. |
List approval items
/v1/client-approvals/itemsclient-approvals.list-items- Permission
- Any workspace member except a Network member
- Rate limit
- 12,000 requests a minute per API key
client_approvals feature on your workspace. Until it is on, calls answer 404.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,limitorcursoris invalid.
Open to any workspace member.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
status | query | string | optional | Only items in this status: pending, approved, changes_requested, superseded or cancelled. |
kind | query | string | optional | Only items of this kind: copy, lead_list, reply, order or campaign_batch. |
campaignId | query | integer (int64) | optional | Only items of this campaign. |
limit | query | integer (int32) | optional | Page size, from 1 to 200. Defaults to 50. |
cursor | query | string | optional | The nextCursor from the previous page. Omit it for the first page. |
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"Response 200
data is a list of ClientApprovalItem. Each item has these fields. The response also carries pagination.
Show the 15 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
Get an approval item
/v1/client-approvals/items/{itemId}client-approvals.get-item- Permission
- Any workspace member except a Network member
- Rate limit
- 12,000 requests a minute per API key
client_approvals feature on your workspace. Until it is on, calls answer 404.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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
itemId | path | integer (int64) | required | Id of the approval item. |
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"Response 200
data is a ClientApprovalItemDetail.
Show the 18 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
Get approval settings
/v1/client-approvals/settingsclient-approvals.get-settings- Permission
- The
workspace_settingspermission - Rate limit
- 12,000 requests a minute per API key
client_approvals feature on your workspace. Until it is on, calls answer 404.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.
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"Response 200
data is a ClientApprovalSettings.
Show the 7 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
List approval events
/v1/client-approvals/eventsclient-approvals.list-events- Permission
- Any workspace member except a Network member
- Rate limit
- 12,000 requests a minute per API key
client_approvals feature on your workspace. Until it is on, calls answer 404.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:limitis not from 1 to 200, orcursoris invalid.
Open to any workspace member.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
itemId | query | integer (int64) | optional | Only the entries of this approval item. |
before | query | string (date-time) | optional | Only entries before this time, as an ISO 8601 timestamp. The bound is exclusive, and a cursor replaces it. |
limit | query | integer (int32) | optional | Page size, from 1 to 200. Defaults to 50. |
cursor | query | string | optional | The nextCursor from the previous page. Omit it for the first page. |
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"Response 200
data is a list of ClientApprovalEvent. Each item has these fields. The response also carries pagination.
Show the 8 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
More in Campaigns:CampaignsEmail sequencesLinkedIn sequencesSegment email sequencesSegment LinkedIn sequencesSequence variablesSequences with conditionsSequence importSegmentsLead listsShare linksSending capacityAuto-pausesCampaign languagesLocalized stepsText translationMarket packsCountry complianceCampaign imagesAll resources