> 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: Get approval settings

> **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.

One endpoint of [Client approvals](/docs/api/client-approvals.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## 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
  }
}
```

## Types

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

### 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). |
