Sign in
Schedules_v3

List audit records for a schedule

<!-- theme: info -->

Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:

  1. Update your automations to use the V3 API for all new shift-based schedules
  2. Keep the V2 endpoint for your existing schedules

An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.

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.

For more information see the Audit API Document.

Scoped OAuth requires: audit_records.read

get/v3/schedules/{id}/audit/records

Path parameters

idstring required

The ID of the schedule.

Query parameters

limitinteger

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

cursorstring

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.

sincestring date-time

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

untilstring date-time

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.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

Records matching the query criteria.

recordsAuditRecord[] required— unresolved $ref
limitinteger required

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

next_cursorstring nullable required

An opaque string than will deliver the next set of results when provided as the cursor parameter in a subsequent request. A null value for this field indicates that there are no additional results.

Changes

No recorded changes to this endpoint across all 1 revision of this API.