events

List Events

List Events

Event Sort Order

Events in Benchling are assigned a stable sort order that reflects when the event was processed (not created). The createdAt time is not the stable sorted order of events. For this reason event createdAt time may appear out of order.

get/events

Request

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

Query parameters

pageSizeinteger

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

nextTokenstring

Token for pagination

createdAt.gtestring

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. "2020-05-23".

startingAfterstring

Event ID after which events will be returned.

eventTypesstring

Comma-separated list of event types to return.

pollboolean

When True, the API will always return a nextToken to enable polling events indefinitely.

Response

Returns a list of event resources. For additional JSON examples, click here.

nextTokenstring

Changes

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