Skip to main content
GET
/
audit_events
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const auditEvents = await client.auditEvents.list();

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
object

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

filter
object

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

sort
enum<string>

Set the order of the results by the creation date.

Available options:
asc,
desc
Example:

"desc"

Response

A list of audit log entries.

data
Audit Log Entry · object[]
meta
object