GET /audit/records

List audit trail records matching provided query params or default criteria.

The returned records are sorted by the execution_time from newest to oldest.

See Cursor-based pagination for instructions on how to paginate through the result set.

Only admins, account owners, or global API tokens on PagerDuty account pricing plans with the "Audit Trail" feature can access this endpoint.

For other role based access to audit records by resource ID, see the resource's API documentation.

For more information see the Audit API Document.

Scoped OAuth requires: audit_records.read

Servers

Request headers

Name Type Required Description
Accept String Yes

The Accept header is used as a versioning header.

Default value: "application/vnd.pagerduty+json;version=2"

Content-Type String Yes

Possible values:

  • "application/json"

Default value: "application/json"

Query parameters

Name Type Required Description
method_type String No

Method type filter.

Possible values:

  • "browser"
  • "api_token"
  • "identity_provider"
  • "other"
  • "oauth"
actions String No

Action filter

Possible values:

  • "create"
  • "delete"
  • "update"
limit Integer No

The minimum of the limit parameter used in the request or the maximum request size of the API.

actor_id String No

Actor Id filter. Must be qualified by providing the actor_type param.

method_truncated_token String No

Method truncated_token filter. Must be qualified by providing the method_type param.

until String No

The end of the date range over which you want to search. If not specified, defaults to now(). May not be more than 31 days after since.

actor_type String No

Actor type filter.

Possible values:

  • "app_reference"
  • "user_reference"
  • "api_key_reference"
since String No

The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

cursor String No

Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.

root_resource_types String No

Resource type filter for the root_resource.

Possible values:

  • "users"
  • "schedules"
  • "services"
  • "teams"
  • "escalation_policies"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.