Skip to navigation
v2Events

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.

Authentication

AuthorizationBearer

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

Query parameters

pageSizeintegerOptional0-100Defaults to 50
Number of results to return. Defaults to 50, maximum of 100.
nextTokenstringOptional
Token for pagination
createdAt.gtestringOptional

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

startingAfterstringOptional
Event ID after which events will be returned.
eventTypesstringOptional

Comma-separated list of event types to return.

pollbooleanOptional
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.

eventslist of objectsOptional
nextTokenstringOptional

Errors

400
Bad Request Error