Skip to content

Retrieve a list of events

GET
/events
curl --request GET \
--url 'https://acme.mykreezalid.com/api/v1/events?limit=25' \
--header 'Authorization: Basic <credentials>'

Returns your events, most recent first, 25 per page by default. The query parameters type, status, object and object_id keep only the events whose field equals the value given. No other query parameter is supported, page included: only the first page can be read.

limit
integer
default: 25 <= 100

Number of events per page, at most 100.

type
string

Keep only the events of this type.

object
string

Keep only the events about this kind of resource, e.g. Order.

object_id
integer

Keep only the events about the resource with this identifier.

Success

Media typeapplication/json
object
events
Array<object>
object
id

Event’s unique identifier

integer
type
string
status
string
object
string
object_id
integer
created
string format: date-time

Example generated

{
"events": [
{
"type": "example",
"status": "example",
"object": "example",
"object_id": 1,
"created": "2026-04-15T12:00:00Z"
}
]
}