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

# Sandboxes

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

A sandbox is a workspace of your own, one per member, where sends, domain orders and credit charges are simulated and webhooks still fire. Only its owner can read or change it: another member's sandbox answers `not_found`. Call these routes with your own sign-in or a live API key; a test key works inside its sandbox and is refused here.

Workspace and account. 6 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/sandboxes/openapi.json](/docs/api/sandboxes/openapi.json).

- `GET /v1/sandboxes` - List your sandboxes (`sandboxes.list`): [/docs/api/sandboxes/list.md](/docs/api/sandboxes/list.md)
- `POST /v1/sandboxes` - Create your sandbox and its first test key (`sandboxes.create`): [/docs/api/sandboxes/create.md](/docs/api/sandboxes/create.md)
- `GET /v1/sandboxes/{sandboxId}` - Get your sandbox (`sandboxes.get`): [/docs/api/sandboxes/get.md](/docs/api/sandboxes/get.md)
- `DELETE /v1/sandboxes/{sandboxId}` - Delete your sandbox (`sandboxes.delete`): [/docs/api/sandboxes/delete.md](/docs/api/sandboxes/delete.md)
- `POST /v1/sandboxes/{sandboxId}/reset` - Reset your sandbox to its seed data (`sandboxes.reset`): [/docs/api/sandboxes/reset.md](/docs/api/sandboxes/reset.md)
- `POST /v1/sandboxes/{sandboxId}/test-keys` - Create another test key for your sandbox (`sandboxes.create-test-key`): [/docs/api/sandboxes/create-test-key.md](/docs/api/sandboxes/create-test-key.md)

## List your sandboxes

`GET /v1/sandboxes` - operationId `sandboxes.list`

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

Your own sandbox, as a list of zero or one. Never another member's. `404 not_found` when the workspace
does not have the `developer_sandboxes` feature. Any workspace member.

Needs the `developer_sandboxes` 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/sandboxes/GET/v1/sandboxes)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer (int32) | no | Items per page, from 1 to 200. Omit `limit` and `cursor` to get every item in one response, as before; with only `cursor`, 50 per page. |
| `cursor` | query | string | no | The `nextCursor` of 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 `Sandbox`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The sandbox's workspace id. Send it as `X-Ken-Workspace-Id` to work inside the sandbox. |
| `name` | string | The sandbox workspace's name. |
| `status` | string | Always `ready`: a sandbox is usable as soon as it is returned. |
| `createdAt` | string (date-time) | When the sandbox was created (UTC). |
| `lastResetAt` | string (date-time) | When the sandbox was last reset to its seed data (UTC). Omitted until the first reset. |
| `seed` | SandboxSeed | What was seeded. Only on the response of a create or a reset. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/sandboxes?limit=1" \
  -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": 4102,
      "name": "Sandbox (dana@northwind.example.com)",
      "status": "ready",
      "createdAt": "2026-09-23T15:02:11Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Create your sandbox and its first test key

`POST /v1/sandboxes` - operationId `sandboxes.create`

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 10 requests a day per user |

Creates a sandbox workspace of your own, seeded with campaigns, contacts, sequences, threads and analytics, and
returns one test key for it. The key's `secret` (it starts `kenso_test_`) is returned once: store it
now. A test key works only inside its sandbox, on `Ken-Version: 1.1` routes: another workspace answers it
`404 not_found`. Without `Ken-Version: 1.1` it reaches only the identity reads `GET /v1/me/context`
and `GET /v1/api-keys/validate`; every other legacy route, these sandbox routes and the workspace API key
routes answer it `403`. Nothing in a sandbox leaves Kenso: launching a campaign sends no email, and orders
and charges are simulated.

You are the sandbox's only member. One sandbox per member:

- `409 invalid_state` with the detail code `sandbox_exists`: you already have one. The detail message
names its id; reset or delete it instead.
- `404 not_found`: the workspace does not have the `developer_sandboxes` feature.
- `429 quota_exceeded`: you used your 10 sandbox creates and resets of the last 24 hours. They are counted
per member, not per workspace.

Any member of the header workspace can create one, a view-only member included. You are the Admin of your
sandbox only: your role in each workspace you belong to stays as it is. A request made with a test key is
refused. One made with a live API key
of yours is served, so the CLI and a script can create the sandbox: the test key it returns works only inside
the sandbox, never in your other workspaces. `403 permission_denied`: a test key or another key held to a
permission template, or a Client or Network member seat. `403 forbidden`: no member is behind the
credential.

Needs the `developer_sandboxes` 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/sandboxes/POST/v1/sandboxes)

### 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 201

`data` is a `SandboxCreated`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The sandbox's workspace id. Send it as `X-Ken-Workspace-Id` to work inside the sandbox. |
| `name` | string | The sandbox workspace's name. |
| `status` | string | Always `ready`: a sandbox is usable as soon as it is returned. |
| `createdAt` | string (date-time) | When the sandbox was created (UTC). |
| `lastResetAt` | string (date-time) | When the sandbox was last reset to its seed data (UTC). Omitted until the first reset. |
| `seed` | SandboxSeed | What was seeded. Only on the response of a create or a reset. |
| `testKey` | SandboxTestKey | The sandbox's test key. Its secret is returned once: store it now. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/sandboxes" \
  -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": 4102,
    "name": "Sandbox (dana@northwind.example.com)",
    "status": "ready",
    "createdAt": "2026-09-23T15:02:11Z",
    "seed": {
      "campaigns": 3,
      "contacts": 60,
      "inboxes": 4,
      "threads": 12
    },
    "testKey": {
      "id": "apk_3f9d2c7a5b1e4f608a7c9d2e4b6f8a10",
      "secret": "kenso_test_ExampleOnlyDoNotUseExampleOnlyDoNotUse000000000000",
      "prefix": "kenso_test_Examp",
      "expiresAt": "2027-01-14T09:41:00Z"
    }
  }
}
```

## Get your sandbox

`GET /v1/sandboxes/{sandboxId}` - operationId `sandboxes.get`

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

`404 not_found` when the id is not your own sandbox, or the workspace does not have the
`developer_sandboxes` feature. Any workspace member.

Needs the `developer_sandboxes` 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/sandboxes/GET/v1/sandboxes/%7BsandboxId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `sandboxId` | path | integer (int64) | yes |  |
| `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 `Sandbox`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The sandbox's workspace id. Send it as `X-Ken-Workspace-Id` to work inside the sandbox. |
| `name` | string | The sandbox workspace's name. |
| `status` | string | Always `ready`: a sandbox is usable as soon as it is returned. |
| `createdAt` | string (date-time) | When the sandbox was created (UTC). |
| `lastResetAt` | string (date-time) | When the sandbox was last reset to its seed data (UTC). Omitted until the first reset. |
| `seed` | SandboxSeed | What was seeded. Only on the response of a create or a reset. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/sandboxes/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": 4102,
    "name": "Sandbox (dana@northwind.example.com)",
    "status": "ready",
    "createdAt": "2026-09-23T15:02:11Z"
  }
}
```

## Delete your sandbox

`DELETE /v1/sandboxes/{sandboxId}` - operationId `sandboxes.delete`

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

Revokes every test key of the sandbox, deletes the data a reset deletes (its campaigns, contacts, sequences,
threads, analytics and everything else you created in it), deletes its webhook endpoints and their delivery
history, and deletes the sandbox. That data is gone for good; you can create a new sandbox afterwards. The
request log of its test keys is kept, and its rows expire after 30 days; it cannot be read once the sandbox is
deleted. A delete that fails is safe to call again: it finishes what the first call started.

- `404 not_found`: the id is not your own sandbox, or the workspace does not have the
`developer_sandboxes` feature.
- `429 quota_exceeded` with `Retry-After: 30` and the message "Another sandbox is being reset or
deleted. Try again in 30 seconds.": sandbox data is deleted one sandbox at a time. The test keys are already
revoked; call the delete again to finish it.

Any member of the header workspace. A request made with a test key is refused. `403 permission_denied`:
a test key or another key held to a permission template, or a Client or Network member seat.
`403 forbidden`: no member is behind the credential.

Needs the `developer_sandboxes` 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/sandboxes/DELETE/v1/sandboxes/%7BsandboxId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `sandboxId` | path | integer (int64) | yes |  |
| `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 204

### Request

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

### Example response

```http
HTTP/1.1 204 No Content
```

## Reset your sandbox to its seed data

`POST /v1/sandboxes/{sandboxId}/reset` - operationId `sandboxes.reset`

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 10 requests a day per user |

Deletes everything in the sandbox and seeds it again with the campaigns, contacts, sequences, threads and
analytics a new sandbox starts with. Its test keys and webhook endpoints stay. Returns the sandbox with
`seed` and the new `lastResetAt`. A reset that fails is safe to call again.

- `404 not_found`: the id is not your own sandbox, or the workspace does not have the
`developer_sandboxes` feature.
- `429 quota_exceeded`: you used your 10 sandbox creates and resets of the last 24 hours. They are counted
per member, not per workspace.
- `429 quota_exceeded` with `Retry-After: 30` and the message "Another sandbox is being reset or
deleted. Try again in 30 seconds.": sandbox data is deleted one sandbox at a time, for a reset and for a
delete. A reset refused this way uses none of your creates and resets.

Any member of the header workspace. A request made with a test key is refused. `403 permission_denied`:
a test key or another key held to a permission template, or a Client or Network member seat.
`403 forbidden`: no member is behind the credential.

Needs the `developer_sandboxes` 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/sandboxes/POST/v1/sandboxes/%7BsandboxId%7D/reset)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `sandboxId` | path | integer (int64) | yes |  |
| `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 `Sandbox`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The sandbox's workspace id. Send it as `X-Ken-Workspace-Id` to work inside the sandbox. |
| `name` | string | The sandbox workspace's name. |
| `status` | string | Always `ready`: a sandbox is usable as soon as it is returned. |
| `createdAt` | string (date-time) | When the sandbox was created (UTC). |
| `lastResetAt` | string (date-time) | When the sandbox was last reset to its seed data (UTC). Omitted until the first reset. |
| `seed` | SandboxSeed | What was seeded. Only on the response of a create or a reset. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/sandboxes/812/reset" \
  -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": 4102,
    "name": "Sandbox (dana@northwind.example.com)",
    "status": "ready",
    "createdAt": "2026-09-23T15:02:11Z"
  }
}
```

## Create another test key for your sandbox

`POST /v1/sandboxes/{sandboxId}/test-keys` - operationId `sandboxes.create-test-key`

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

Returns a new test key for the sandbox. Its `secret` (it starts `kenso_test_`) is returned once: store
it now. It works only inside the sandbox, expires after 90 days, and is listed and revoked like any API key.

- `409 invalid_state` with the detail code `test_key_limit_reached`: the sandbox already has 5 active
test keys. Revoke one first.
- `404 not_found`: the id is not your own sandbox, or the workspace does not have the
`developer_sandboxes` feature.

Any member of the header workspace. A request made with a test key is refused. `403 permission_denied`:
a test key or another key held to a permission template, or a Client or Network member seat.
`403 forbidden`: no member is behind the credential.

Needs the `developer_sandboxes` 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/sandboxes/POST/v1/sandboxes/%7BsandboxId%7D/test-keys)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `sandboxId` | path | integer (int64) | yes |  |
| `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 201

`data` is a `SandboxTestKey`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | The key's id, as the API keys list shows it. |
| `secret` | string | The key itself, starting `kenso_test_`. Returned once and never shown again. |
| `prefix` | string | The first characters of the key, for telling keys apart. |
| `expiresAt` | string (date-time) | When the key stops working (UTC). |

### Request

```bash
curl -X POST "https://api.ken.so/v1/sandboxes/812/test-keys" \
  -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": "apk_3f9d2c7a5b1e4f608a7c9d2e4b6f8a10",
    "secret": "kenso_test_ExampleOnlyDoNotUseExampleOnlyDoNotUse000000000000",
    "prefix": "kenso_test_Examp",
    "expiresAt": "2027-01-14T09:41:00Z"
  }
}
```

## Types

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

### SandboxSeed

How much seed data a create or a reset wrote into the sandbox.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `campaigns` | integer (int32) | no | Seeded campaigns. |
| `contacts` | integer (int32) | no | Seeded contacts. |
| `inboxes` | integer (int32) | no | Seeded sending inboxes. They are simulated: no mailbox exists behind them. |
| `threads` | integer (int32) | no | Seeded conversation threads. |

### SandboxTestKey

A test key: a `kenso_test_` API key that works only inside its sandbox.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no | The key's id, as the API keys list shows it. |
| `secret` | string | no | The key itself, starting `kenso_test_`. Returned once and never shown again. |
| `prefix` | string | no | The first characters of the key, for telling keys apart. |
| `expiresAt` | string (date-time) | no | When the key stops working (UTC). |

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