List Audit Logs

GET 
/audit_events

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

Query Parameters

page[number] integer

Page number to load.

page[size] integer

Number of items per page.

filter[created_before] date-time

Filter for audit events created before a specific date.

filter[created_after] date-time

Filter for audit events created after a specific date.

sort string

Possible values: [asc, desc]

Set the order of the results by the creation date.

200: A list of audit log entries.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Unique identifier for the audit log entry.

user_id uuid

Unique identifier for the user who made the change.

record_type string

The type of the resource being audited.

resource_id string

Unique identifier for the resource that was changed.

organization_id uuid

Unique identifier for the organization that owns the resource.

change_type string

The type of change that occurred.

created_at date-time

ISO 8601 formatted date indicating when the change occurred.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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",
      "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
  }
}

default: Unexpected error.

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

Error code.

title string

Short description of the error.

detail string

Detailed information about the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "Unauthorized",
      "detail": "The request requires user authentication."
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/audit_events' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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",
      "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
  }
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Unauthorized",
      "detail": "The request requires user authentication."
    }
  ]
}