listPublicWorkspaces

List public workspaces

GET/v1/admin/workspaces/public

Authorization

AuthorizationBearerrequired

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

Header parameters

x-multiple-integrationsstring

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.

Query parameters

nextTokenstring

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

workspaceIdsstring[]

Ids of the workspaces to list

searchstring

Search query

Response

Success

workspacesobject[]required

metaobjectrequired

Request

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

Response

{
  "workspaces": [
    {
      "id": "string",
      "name": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "about": "",
      "profilePicture": "",
      "contactEmail": "",
      "website": "",
      "socialAccounts": [],
      "handle": ""
    }
  ],
  "meta": {
    "nextToken": "string"
  }
}