getWorkspace

Get workspace details

GET /v1/admin/workspaces/{id}

cURL

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/admin/workspaces/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "ownerId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "botCount": 123,
  "blocked": true,
  "spendingLimit": 123,
  "activeTrialId": "<string>",
  "about": "",
  "profilePicture": "",
  "contactEmail": "",
  "website": "",
  "socialAccounts": [],
  "isPublic": true,
  "handle": "<string>"
}

Authorizations

Authorization · string · header · required

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

Headers

x-multiple-integrations · string

Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Path Parameters

id · string · required

Workspace ID

Response

200

application/json

Success

id · string · required

name · string · required

ownerId · string · required

createdAt · string · required

updatedAt · string · required

botCount · number · required

billingVersion · enum<string> · required

Available options: v1, v2, v3, v4

plan · enum<string> · required

Available options: community, team, enterprise, plus

blocked · boolean · required

spendingLimit · number · required

activeTrialId · string | null · required

about · string · default: ""

profilePicture · string · default: ""

contactEmail · string · default: ""

website · string · default: ""

socialAccounts · string[]

isPublic · boolean

handle · string