BEbenchling
Audit Log

List AuditLog items

List AuditLog items.

This endpoint is paginated. It returns 50 rows by default and accepts a maximum of 100 rows per request. Use pageSize and nextToken to retrieve additional pages.

get/api/v3/audit-log/items

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Query parameters

action.anyOfstring[]

Restricts results to audit logs matching any of the specified action display names (e.g. 'Updated name', 'Created'). Comma-separated list.

createdAt.gtstring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.

createdAt.gtestring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30.

createdAt.ltstring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.

createdAt.ltestring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30.

id.anyOfstring[]

Restricts results to those matching any of the specified IDs. Comma-separated list.

nextTokenstring

Token for pagination

objectId.anyOfstring[]

Retrieves audit logs for the specified object API IDs. A maximum of 10 IDs can be specified. Comma-separated list.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

pageSizeinteger

Number of results to return. Defaults to 50, maximum of 100.

reasonCode.anyOfstring[]

Restricts results to audit logs with any of the specified reason codes. Comma-separated list.

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

userId.anyOfstring[]

Restricts results to those associated with any of the specified user API IDs. Comma-separated list.

sort'createdAt:asc' | 'createdAt:desc'

Method by which to order results. Valid sorts are: createdAt (created time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is createdAt:asc.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

OK

nextTokenstring nullable

Changes

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