GET
/
v1
/
admin
/
workspace-members
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/workspace-members \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <api-key>'
{
  "members": [
    {
      "id": "<string>",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "createdAt": "<string>",
      "role": "viewer",
      "profilePicture": "<string>",
      "displayName": "<string>"
    }
  ],
  "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

Response

200
application/json

Success

The response is of type object.