Audit Logs

Get a list of audit logs

get

/audit-logs

Returns a paginated list of audit log entries for the organization.

Rate limit: 300 requests per minute

Authorizations

AuthorizationstringRequired

Authorization: Bearer

Query parameters

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

The number of audit logs to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

403

The authenticated caller or organization is not allowed to access this endpoint or operation.

application/json

500

An unexpected internal error occurred.

application/json

get/audit-logs

GET /audit-logs HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "action": "text",
      "action_happened_at": "text",
      "actor_contact_id": "text",
      "actor_user_id": "text",
      "attributes": {
        "field": "status",
        "new_value": "closed",
        "old_value": "open"
      },
      "created_at": "text",
      "id": "text",
      "link": "text",
      "metadata": {},
      "object_id": "text",
      "object_type": "text",
      "source": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Search audit logs with filters

post

/audit-logs/search

Returns a filtered, paginated list of audit log entries for the organization. Filterable fields and their allowed operators:

Field	Allowed operators
action	equals, in, not_in, string_contains, string_does_not_contain
action_happened_at	time_is_after, time_is_before, time_range

Timestamp values use RFC3339 format.

Rate limit: 30 requests per minute

Authorizations

AuthorizationstringRequired

Authorization: Bearer

Body

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

The number of audit logs to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

403

The authenticated caller or organization is not allowed to access this endpoint or operation.

application/json

500

An unexpected internal error occurred.

application/json

post/audit-logs/search

POST /audit-logs/search HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "cursor": "text",
  "filter": {
    "field": "text",
    "operator": "equals",
    "subfilters": [
      {
        "field": "state",
        "operator": "equals",
        "value": "new"
      }
    ],
    "value": "text",
    "values": [
      "text"
    ]
  },
  "limit": 1
}

{
  "data": [
    {
      "action": "text",
      "action_happened_at": "text",
      "actor_contact_id": "text",
      "actor_user_id": "text",
      "attributes": {
        "field": "status",
        "new_value": "closed",
        "old_value": "open"
      },
      "created_at": "text",
      "id": "text",
      "link": "text",
      "metadata": {},
      "object_id": "text",
      "object_type": "text",
      "source": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}