Skip to main content
GET
/
v1
/
admin
/
workspaces
/
public
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/workspaces/public \
  --header 'Authorization: Bearer <token>'
{
  "workspaces": [
    {
      "id": "<string>",
      "name": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "about": "",
      "profilePicture": "",
      "contactEmail": "",
      "website": "",
      "socialAccounts": [],
      "handle": ""
    }
  ],
  "meta": {
    "nextToken": "<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.

Query Parameters

​
nextToken
string

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

​
workspaceIds
string[]

Ids of the workspaces to list

​
search
string

Search query

Response

Success

​
workspaces
getPublicWorkspaceResponse · object[]
required
​
meta
object
required