v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Audit Logs

List Audit Logs

Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes.

get/audit_events

Query parameters

numberinteger

Page number to load.

sizeinteger

Number of items per page.

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

{
  "number": 1,
  "size": 10
}

created_afterstring date-time

Filter for audit events created after a specific date.

created_beforestring date-time

Filter for audit events created before a specific date.

Consolidated filter parameter (deepObject style). Originally: filter[created_before], filter[created_after]

{
  "created_after": "2021-01-08T00:00:00Z",
  "created_before": "2021-01-08T00:00:00Z"
}

sort'asc' | 'desc'

Example:desc

Set the order of the results by the creation date.

Response

A list of audit log entries.

Example response

{
  "data": [
    {
      "alternate_resource_id": "+14155551234",
      "change_made_by": "organization_member",
      "change_type": "update",
      "changes": [
        {
          "field": "field.name",
          "from": "new value",
          "to": "old value"
        }
      ],
      "created_at": "2026-01-03T00:00:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440003",
      "record_type": "audit_event",
      "resource_id": "550e8400-e29b-41d4-a716-446655440002",
      "user_id": "550e8400-e29b-41d4-a716-446655440001"
    }
  ],
  "meta": {
    "page_number": 1,
    "page_size": 10,
    "total_pages": 3,
    "total_results": 50
  }
}