View all methods

auditLogs.list

List account audit log events, ordered by newest first.

Facts

Method	GET https://api.getdx.com/auditLogs.list
Required scope	auditLogs:read

Arguments

Required arguments

Name	Type	Description
token	Token	Auth token passed as an HTTP header.

Optional arguments

Name	Type	Description
limit	Integer	Number of events to return. Must be between 1 and 100. Defaults to 50.
cursor	Text	Cursor for pagination. Use response_metadata.next_cursor from the previous response.

Usage info

• Results are ordered by time in descending order.
• Pagination uses a time-based cursor.
• Cursor pagination can repeat the boundary event across pages; dedupe by stable fields in your client if needed.

Example request

This is a typical request:

curl -sS -G "https://api.getdx.com/auditLogs.list" \
  -H "Authorization: Bearer xxxx-xxxxxxxxx-xxxx" \
  -H "Accept: application/json" \
  --data-urlencode 'limit=25'

Example response

This is a typical success response:

{
  "ok": true,
  "audit_logs": [
    {
      "user": {
        "id": "NTEyMDUw",
        "name": "Jane Smith",
        "email": "jane@example.com"
      },
      "event_type": "sessions.created",
      "time": "2026-06-03T20:11:00.123Z",
      "ip_address": "1.2.3.4",
      "context": {
        "source": "slack_auth"
      },
      "user_agent": "Mozilla/5.0",
      "performed_by_dx_user": false
    }
  ],
  "response_metadata": {
    "next_cursor": "eyJ0cyI6IjIwMjYtMDYtMDNUMjA6MTE6MDAuMTIzNDU2WiJ9"
  }
}

Response fields

Field	Type	Description
ok	Boolean	Indicates whether the request succeeded.
audit_logs	Array	List of audit log events.
response_metadata.next_cursor	String | null	Cursor for fetching the next page of results.

Each object in audit_logs includes:

Field	Type	Description
user	Object | null	User associated with the event.
event_type	String	Event type in <resource>.<action> format when a resource exists, otherwise <action>.
time	String	Event timestamp (ISO 8601).
ip_address	String | null	Client IP address captured for the event.
context	Object | null	Event-specific context payload.
user_agent	String | null	User agent string captured for the event.
performed_by_dx_user	Boolean	true when the event was performed by a DX user.

Possible resource values:

[
  "settings",
  "roles",
  "sso",
  "api_keys",
  "data",
  "connections",
  "db_access",
  "deploy_rules",
  "sessions"
]

Possible action values:

["updated", "created", "deleted"]

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok param in the response.

Error	Description
not_authed	No authentication token provided.
not_authorized	The bearer token does not include auditLogs:read.
invalid_arguments	One or more arguments are invalid.