For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organization

Read the organization behind your access token, including the plans it can put a client workspace on.

Your token identifies one organization, so this endpoint takes no id: it always reads as the organization the token belongs to. Its id is the uuid Kick holds for your firm, and name is the firm name shown in the product.

allowedPlans is the set of plans your organization can put a client workspace on, and it is exactly what plan accepts on workspace create and update. Reading it is how an integration learns which values a request may send, instead of discovering a rejected plan as a 400.

Retrieve the organization

get

Returns the organization behind the access token: its id, name and the plans it may assign to a client workspace.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Responses
200

200

application/json
get/platform/v1/organization
GET /api/platform/v1/organization HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "organization": {
    "allowedPlans": [
      "FREE"
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
}

Last updated

Was this helpful?