GET
/
v1
/
admin
/
workspaces
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <api-key>'
{
  "workspaces": [
    {
      "id": "<string>",
      "name": "<string>",
      "ownerId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "botCount": 123,
      "billingVersion": "v1",
      "plan": "community",
      "blocked": true,
      "spendingLimit": 123,
      "about": "",
      "profilePicture": "",
      "contactEmail": "",
      "website": "",
      "socialAccounts": [],
      "isPublic": true,
      "handle": ""
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

x-workspace-id
string
header
required

Your workspace ID.

Query Parameters

nextToken
string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

handle
string

Workspace handle

Response

200
application/json

Success

workspaces
updateWorkspaceResponse · object[]
required
meta
object
required