Skip to main content
POST
Read Events

Headers

x-prefect-api-version
string

Body

application/json
filter
EventFilter · object | null

Additional optional filter criteria to narrow down the set of Events

limit
integer
default:50

The number of events to return with each page

Required range: 0 <= x <= 50

Response

Successful Response

A single page of events returned from the API, with an optional link to the next page of results

events
ReceivedEvent · object[]
required

The Events matching the query

total
integer
required

The total number of matching Events

next_page
string<uri> | null
required

The URL for the next page of results, if there are more

Minimum string length: 1