List events

GET

/api/v1/events

Docs menu

The events of the last 30 days, newest first. These are the same events a webhook sends: poll here if you cannot receive webhooks.

Key
Bearer key, test or live
Scope
read

Parameters

typestringoptional

Only events of this type, such as check.completed.

limitintegeroptional

How many objects to return, 1 to 100. Default 20.

Default: 20

starting_afterstringoptional

The id of the last object you have. Returns the objects after it. Newest first.

Response

200. A page of events.

objectstring

list

dataarray of object
Show child fields
idstring

evt_...

objectstring

event

typestring

See Events on the Webhooks page.

livemodeboolean
api_versionstring

v1

createdinteger

Unix time in seconds.

dataobject
has_moreboolean
next_starting_afterstring or null

Pass this as starting_after to read the next page.

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
event_type_unknown400One of the event types is not a PressProve event.
limit_invalid400The limit must be a whole number from 1 to 100.
cursor_invalid400The starting_after cursor does not name an object in this list.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode