List audit log sinks

Gets a list of audit log sinks defined on this entity.

Required permission

Account > Admin > AuditLogSinks > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

auditLogSinks
[array] required
An array of audit log sinks defined for this entity.

{object}
An audit log sink object.

id
string required
Identifier for the audit log sink.
name
string required
Name of the audit log sink.
description
string
Description of the audit log sink.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
sinkType
string required
The type of the audit log sink.
one of
aws_s3
includeSpec
boolean required
Whether exported events include the enriched `before`/`after` spec or only headers.
status
string required
Current status of the audit log sink.
one of
paused, running, failing, creating
createdAt
string required
Timestamp of when the audit log sink was created.
updatedAt
string required
Timestamp of when the audit log sink was last updated.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/integrations/audit-log-sinks

GET /v1/teams/{teamId}/integrations/audit-log-sinks

Example response

200 OK

The list of audit log sinks.

JSON

{
  "data": {
    "auditLogSinks": [
      {
        "id": "compliance-bucket",
        "name": "compliance-bucket",
        "description": "Forwards audit logs to the compliance S3 bucket.",
        "sinkType": "aws_s3",
        "includeSpec": false,
        "createdAt": "2026-05-11T12:00:00.000Z",
        "updatedAt": "2026-05-11T12:00:00.000Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}