Skip to main content
GET
/
v1
/
admin
/
workspaces
/
{id}
/
audit-records
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/workspaces/{id}/audit-records \
  --header 'Authorization: Bearer <token>'
{
  "records": [
    {
      "id": "<string>",
      "recordedAt": "2023-11-07T05:31:56Z",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resourceId": "<string>",
      "action": "UNKNOWN",
      "userEmail": "<string>",
      "resourceName": "<string>",
      "value": "<string>"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://botpress.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
nextToken
string

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

Response

List of audit records

​
records
object[]
required
​
meta
object
required
Last modified on March 20, 2026