Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
AuditLogs

List audit log entries by Organization

List all available audit log entries in the Organization that match the specified filters. This API returns entries from newest to oldest and is paginated. Only successful create, modify, or delete requests are stored in the audit log. This API may return a lot of data, depending on the size of the Organization, so it is recommended to use the "to" and "from" query parameters to limit the returned data to the time window of interest. Each response contains at most 32 days worth of data for performance reasons and may be empty if no records exist within that time range. Pagination links in the 'Link' header should always be followed when present. This API requires administrator permissions in the Organization.

get/orgs/{orgId}/audit-logs

Path parameters

orgIdstring required

The Organization ID

Query parameters

per_pageinteger

The maximum number of items to return in a page of results

pagestring

The page token to request from

fromstring date-time

Optional filter for entries created after the given time.

tostring date-time

Optional filter for entries created before the given time.

Response

Successful list response.

atstring date-time required

The date and time when the event was recorded.

org_idstring

The id of the Organization this event occurred in.

user_idstring required

The id of the User who triggered the event.

request_methodstring required

The HTTP method that was requested. Only POST, PATCH, PUT, and DELETE are audited.

request_pathstring required

The URL path that was called.

response_statusinteger required

The status code of the response. Only successful responses are audited.

Example response

[
  {
    "at": "2023-01-01T00:00:00Z",
    "org_id": "my-organization",
    "user_id": "01234567-89ab-cdef-0123-456789abcdef",
    "request_method": "POST",
    "request_path": "/orgs/some-org/apps",
    "response_status": 201
  }
]