> For the complete documentation index, see [llms.txt](https://docs.kick.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kick.co/api/api-reference/workspaces.md).

# Workspaces

List and create the workspaces in your organization's book of business, and read, update, or delete a single workspace.

A workspace is one client's set of books. Every workspace these endpoints return belongs to the organization that issued your token, so a workspace outside your book of business reads as `404`.

A workspace you create through the API is billed to your organization rather than to the client, so `plan` is required on create and has to be one of the plans your organization can assign. The [Organization](/api/api-reference/organization.md) endpoint returns that set as `allowedPlans`, and a plan outside it is rejected with `400`.

Updating a workspace changes its plan and nothing else. Its timezone stays frozen at create. The new plan takes effect immediately and changes what Kick bills your organization for the client, so the request answers `400` when your organization does not own the workspace's billing, and again when the plan is not one your organization can assign.

Deleting a workspace is permanent and takes the whole client with it: its entities, financial accounts, transactions, and documents. Only a workspace your organization fully controls can be deleted, so the request answers `400` when your organization does not own the workspace's billing, or when users from outside your organization are still assigned to it. Remove those users first, or contact support to transfer ownership. To delete one business and keep the rest of the client's books, delete the [entity](/api/api-reference/entities.md) instead.

## List workspaces

> Returns the workspaces in the organization's book of business. Results are paged with \`limit\`/\`offset\`.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces":{"get":{"description":"Returns the workspaces in the organization's book of business. Results are paged with `limit`/`offset`.","operationId":"workspaces.list","parameters":[{"in":"query","name":"limit","schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"offset","schema":{"default":0,"minimum":0,"nullable":true,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"plan":{"enum":["FREE","BASIC","PLUS","ADVANCED","READ_ONLY"],"type":"string"},"timezone":{"enum":["America/New_York","America/Chicago","America/Denver","America/Phoenix","America/Los_Angeles","America/Anchorage","America/Adak","Pacific/Honolulu","America/Puerto_Rico","Pacific/Guam","Pacific/Pago_Pago","UTC"],"type":"string"}},"required":["id","name","timezone","plan","createdAt"],"type":"object"},"type":"array"},"pagination":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}},"required":["limit","offset","total"],"type":"object"}},"required":["data","pagination"],"type":"object"}}},"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"List workspaces","tags":["workspaces"]}}}}
```

## Create a workspace

> Creates a workspace in the organization's book of business, billed to the organization. The plan is required and must be one of the organization's allowed plans; changing it later follows the update endpoint rules. Optional timezone must be one of: America/New\_York, America/Chicago, America/Denver, America/Phoenix, America/Los\_Angeles, America/Anchorage, America/Adak, Pacific/Honolulu, America/Puerto\_Rico, Pacific/Guam, Pacific/Pago\_Pago, UTC. Used to resolve accounting calendar days from timestamps. Frozen at create.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces":{"post":{"description":"Creates a workspace in the organization's book of business, billed to the organization. The plan is required and must be one of the organization's allowed plans; changing it later follows the update endpoint rules. Optional timezone must be one of: America/New_York, America/Chicago, America/Denver, America/Phoenix, America/Los_Angeles, America/Anchorage, America/Adak, Pacific/Honolulu, America/Puerto_Rico, Pacific/Guam, Pacific/Pago_Pago, UTC. Used to resolve accounting calendar days from timestamps. Frozen at create.","operationId":"workspaces.create","parameters":[{"description":"A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with `Idempotent-Replayed: true`) instead of executing again.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"maxLength":200,"minLength":1,"type":"string"},"plan":{"description":"Supported values: FREE, BASIC, PLUS, ADVANCED, READ_ONLY. Only plan enabled for your organization can be chosen.","enum":["FREE","BASIC","PLUS","ADVANCED","READ_ONLY"],"type":"string"},"timezone":{"description":"Supported values: America/New_York, America/Chicago, America/Denver, America/Phoenix, America/Los_Angeles, America/Anchorage, America/Adak, Pacific/Honolulu, America/Puerto_Rico, Pacific/Guam, Pacific/Pago_Pago, UTC. Used to resolve accounting calendar days from timestamps. Frozen at create. Defaults to America/Los_Angeles.","enum":["America/New_York","America/Chicago","America/Denver","America/Phoenix","America/Los_Angeles","America/Anchorage","America/Adak","Pacific/Honolulu","America/Puerto_Rico","Pacific/Guam","Pacific/Pago_Pago","UTC"],"type":"string"}},"required":["name","plan"],"type":"object"}}},"description":"Body"},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"workspace":{"properties":{"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"plan":{"enum":["FREE","BASIC","PLUS","ADVANCED","READ_ONLY"],"type":"string"},"timezone":{"enum":["America/New_York","America/Chicago","America/Denver","America/Phoenix","America/Los_Angeles","America/Anchorage","America/Adak","Pacific/Honolulu","America/Puerto_Rico","Pacific/Guam","Pacific/Pago_Pago","UTC"],"type":"string"}},"required":["id","name","timezone","plan","createdAt"],"type":"object"}},"required":["workspace"],"type":"object"}}},"description":"201"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Create a workspace","tags":["workspaces"]}}}}
```

## Retrieve a workspace

> Returns a single workspace. A workspace outside the organization's book of business reads as not found.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces/{workspaceId}":{"get":{"description":"Returns a single workspace. A workspace outside the organization's book of business reads as not found.","operationId":"workspaces.get","parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"workspace":{"properties":{"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"plan":{"enum":["FREE","BASIC","PLUS","ADVANCED","READ_ONLY"],"type":"string"},"timezone":{"enum":["America/New_York","America/Chicago","America/Denver","America/Phoenix","America/Los_Angeles","America/Anchorage","America/Adak","Pacific/Honolulu","America/Puerto_Rico","Pacific/Guam","Pacific/Pago_Pago","UTC"],"type":"string"}},"required":["id","name","timezone","plan","createdAt"],"type":"object"}},"required":["workspace"],"type":"object"}}},"description":"200"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Retrieve a workspace","tags":["workspaces"]}}}}
```

## Update a workspace

> Updates the fields present in the body and leaves the others untouched. Changing \`plan\` requires the organization to own the workspace billing; the new plan takes effect immediately and is reflected in the organization's billed quantities.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces/{workspaceId}":{"patch":{"description":"Updates the fields present in the body and leaves the others untouched. Changing `plan` requires the organization to own the workspace billing; the new plan takes effect immediately and is reflected in the organization's billed quantities.","operationId":"workspaces.update","parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with `Idempotent-Replayed: true`) instead of executing again.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"plan":{"description":"Supported values: FREE, BASIC, PLUS, ADVANCED, READ_ONLY. The organization must own the workspace billing. Only plan enabled for your organization can be chosen.","enum":["FREE","BASIC","PLUS","ADVANCED","READ_ONLY"],"type":"string"}},"required":["plan"],"type":"object"}}},"description":"Body"},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"workspace":{"properties":{"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"plan":{"enum":["FREE","BASIC","PLUS","ADVANCED","READ_ONLY"],"type":"string"},"timezone":{"enum":["America/New_York","America/Chicago","America/Denver","America/Phoenix","America/Los_Angeles","America/Anchorage","America/Adak","Pacific/Honolulu","America/Puerto_Rico","Pacific/Guam","Pacific/Pago_Pago","UTC"],"type":"string"}},"required":["id","name","timezone","plan","createdAt"],"type":"object"}},"required":["workspace"],"type":"object"}}},"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Update a workspace","tags":["workspaces"]}}}}
```

## Delete a workspace

> Permanently deletes a workspace together with all of its entities, financial accounts, transactions and documents. The organization must own the workspace billing and be the only organization assigned to the workspace. This cannot be undone.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces/{workspaceId}":{"delete":{"description":"Permanently deletes a workspace together with all of its entities, financial accounts, transactions and documents. The organization must own the workspace billing and be the only organization assigned to the workspace. This cannot be undone.","operationId":"workspaces.delete","parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with `Idempotent-Replayed: true`) instead of executing again.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"responses":{"200":{"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Delete a workspace","tags":["workspaces"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.kick.co/api/api-reference/workspaces.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.