Workspaces
List and create the workspaces in your organization's book of business, and read 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 starts on the Plus plan and is billed to your organization, since the organization owns it rather than the client.
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 instead.
Returns the workspaces in the organization's book of business. Results are paged with limit/offset.
Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....
1000200
400
401
429
GET /api/platform/v1/workspaces HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"timezone": "America/New_York"
}
],
"pagination": {
"limit": 1,
"offset": 1,
"total": 1
}
}Creates a workspace in the organization's book of business, on the Plus plan and billed to the organization. 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.
Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....
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.
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.
201
400
401
429
POST /api/platform/v1/workspaces HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"name": "text",
"timezone": "America/New_York"
}{
"workspace": {
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"timezone": "America/New_York"
}
}Returns a single workspace. A workspace outside the organization's book of business reads as not found.
Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....
200
401
404
429
GET /api/platform/v1/workspaces/{workspaceId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"workspace": {
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"timezone": "America/New_York"
}
}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.
Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....
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.
200
No content
400
401
404
429
DELETE /api/platform/v1/workspaces/{workspaceId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?