Skip to content
Reference
/
/
List audit trail events

List audit trail events

Request

🔒 Private label — contact sales. Requires a private-label entitlement on your API client.

List audit trail events

Security
oauth2ClientCredentials(Required scopes: audit-trail:read)
Query
pagenumber

Page number

Example:page=1
limitnumber

Items per page (max 1000)

Example:limit=15
Headers
business_idstringrequired

Business identifier for the request

curl -i -X GET \
  'https://developer.boyahq.com/_mock/v2/openapi/audit-trail?page=1&limit=15' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'business_id: string'

Responses

List of audit trail events

Bodyapplication/json
docsArray of objects(AuditEventV1Dto)

Audit event documents

totalnumber

Total count

limitnumber

Limit per page

pagenumber

Current page

pagesnumber

Total pages

Response
{
  "docs": [
    { … }
  ],
  "total": 0,
  "limit": 0,
  "page": 0,
  "pages": 0
}