Skip to main content
GET
GET events instances
List all available events. Note that events are generated on-demand and only listed and available programmatically if a relevant webhook subscription exists. By default, up to 30 days of events are available via this route. If you need additional historic event records, please contact us at support@onecodex.com.

Authorizations

X-API-Key
string
header
required

Query Parameters

page
integer<int32>
default:1

Page number. Defaults to 1. See Pagination for more details.

per_page
integer<int32>
default:50

Number of requested paginated records. Defaults to 50. See Pagination for more details.

sort
string | null

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

where
string | null

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

200 - application/json

OK

$uri
string
required
read-only
Pattern: ^/api/v1/events/[a-f0-9]{16}$
Example:

"/api/v1/events/0d77065796f8d173"

payload
Payload · object
required

The webhook payload.

status
enum<string>
required

The status of the webhook for the event.

Available options:
success,
failed,
pending,
retryable