Skip to main content
POST
List

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The TaskAuditListRequest message.

commentsOnly
boolean

When true, only comment events are returned, so a page of page_size holds page_size comments rather than a mix of comments and state-change events.

excludeComments
boolean

When true, comment events are excluded from the response and the count, so a page of page_size holds page_size non-comment events. Mutually exclusive with comments_only.

newestFirst
boolean

When true, events are returned newest-first (descending created_at) instead of the default chronological (ascending) order.

pageSize
integer<int32>

The maximum number of audit events to return per page.

pageToken
string

A pagination token from a previous response to retrieve the next page.

refs
Task Audit View Ref · object[] | null

References to specific audit events to retrieve. If provided, only these events are returned.

taskId
string

The ID of the task to list audit events for.

Response

200 - application/json

Successful response

The TaskAuditListResponse message.

list
Task Audit View · object[] | null

The list of audit events for the task.

nextPageToken
string

A pagination token to retrieve the next page of results.

totalCount
string<int64> | null

The total number of audit events the list returns for this request: comment events when comments_only is true, non-comment events when exclude_comments is true, all events otherwise. This is an upper bound: a small number of internal-only events (e.g. connector-action results with no pending reason) are omitted from list, so the count can exceed the rows reachable by paging. Only returned for the first page (a request with no page_token). Unset when the request filters by refs (the count is undefined for ref lookups) or when the count could not be computed.