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

# Placement tests: Return what the start dialog needs to offer a Kenso placement test

> **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 [Placement tests](/docs/api/placement-tests.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Return what the start dialog needs to offer a Kenso placement test

`GET /v1/placement-tests/availability` - operationId `placement-tests.availability`

| Permission | Rate limit |
| --- | --- |
| Delivery view | 12,000 requests a minute per API key |

Always `200`. `enabled: false` means this workspace keeps the mailbox provider's engine.
`planAllowed`: the plan can start Kenso tests. `providers`: each seed provider and whether it runs
tests now. `control`: whether a test can add the control arm, and why not. The test counters are what the
workspace's budget leaves today and this month (omitted when unknown); `senderTestsPerDay` is the cap per
sending inbox. Requires Delivery view.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/placement-tests/GET/v1/placement-tests/availability)

### 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 `PlacementAvailability`.

| Field | Type | Description |
| --- | --- | --- |
| `enabled` | boolean | The Kenso engine runs for this workspace (flag on, not paused). |
| `planAllowed` | boolean | The workspace's plan can start Kenso tests (paid plans; staff and Kenso workspaces always). |
| `providers` | array of PlacementProviderAvailability | Every seed provider, `google_workspace` then `microsoft_365`, and whether it runs tests now. |
| `seedsPerArm` | integer (int32) | Seed inboxes each arm sends to across the active providers. |
| `control` | PlacementControlAvailability | Whether a test can add the control arm; `reason` says why not. |
| `testsLeftToday` | integer (int32) |  |
| `testsLeftThisMonth` | integer (int32) |  |
| `testsPerDay` | integer (int32) |  |
| `testsPerMonth` | integer (int32) |  |
| `senderTestsPerDay` | integer (int32) | Tests one sending inbox can be part of in 24 hours. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/placement-tests/availability" \
  -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": {
    "enabled": true,
    "planAllowed": true,
    "providers": [
      {
        "provider": "string",
        "active": true
      }
    ],
    "seedsPerArm": 1,
    "control": {
      "available": true,
      "reason": "string"
    },
    "testsLeftToday": 1,
    "testsLeftThisMonth": 1,
    "testsPerDay": 1,
    "testsPerMonth": 1,
    "senderTestsPerDay": 1
  }
}
```

## Types

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

### PlacementProviderAvailability

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `provider` | string | no |  |
| `active` | boolean | no |  |

### PlacementControlAvailability

Whether a test can add the control arm; `reason` says why not.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `available` | boolean | no |  |
| `reason` | string | no |  |
