Skip to main content
GET
/
events
List all events
curl --request GET \
  --url https://api.flatpeak.com/events \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorization
string
header
required

Authenticate with bearer_token you obtained from /login endpoint.

Query Parameters

event_type
string

Type of event.

starting_after
string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the next page in the list include starting_after where ID is the last ID in the currently retrieved list.

ending_before
string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the previous page in the list, include ending_before, which is the first ID in the currently retrieved list.

limit
integer

A limit on the number of objects to be returned. Can range between 1 and 100, and the default is 30.

object_id
string

Filter events by Flatpeak identifier such as a location ID.

Example:

"loc_641b90b758fb8e6293716e40"

Response

object
string

Represents the object’s type. i.e. list.

Example:

"list"

url
string

Represents the URL slug for the object.

Example:

"/events"

has_more
boolean

Is set to true if more objects are available.

data
object[]