Skip to main content

List Audit Logs

GET 
/audit_events

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

Request ​

Query Parameters

    page[number] number

    Page number to load

    page[size] number

    Size of the 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 how the results will be ordered by the creation date.

Responses ​

200: List of audit log entries

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

    Identifies the type of the resource.

    resource_id string

    Unique identifier for the resource that was changed

    organization_id uuid

    Unique identifier for the organization that owns the resource

    changes

    object[]

    nullable

  • Array [

    • field string

    Identifies the name of the field that was changed

    from nullable

    Value of the field before the change was made. This field can be any JSON type.

    to nullable

    Value of the field after the change was made. This field can be any JSON type.

  • ]

    • change_made_by string

    Possible values: [account_owner, organization_member, account_manager, telnyx]

    Indicates what type of user made the change

    resource_type string

    Identifies the type of the resource that was changed

    change_type string

    Identifies the type of change that was made

    created_at date-time

    ISO 8601 formatted date indicating when the change was made

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

Request samples

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

Response samples

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "record_type": "audit_event",
      "resource_id": "string",
      "organization_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "changes": [
        {
          "field": "inbound.timeout_1xx_secs"
        }
      ],
      "change_made_by": "account_owner",
      "resource_type": "string",
      "change_type": "string",
      "created_at": "2020-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}