getPublicWorkspace

Get workspace public details

GET /v1/admin/workspaces/{id}/public

cURL

cURL

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

200

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "about": "",
  "profilePicture": "",
  "contactEmail": "",
  "website": "",
  "socialAccounts": [],
  "handle": ""
}

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

createdAt · string · required

updatedAt · string · required

about · string · default: ""

profilePicture · string · default: ""

contactEmail · string · default: ""

website · string · default: ""

socialAccounts · string[]

handle · string · default: ""