Skip to content

Get events

GET
/api/events

Get events. By default, returns upcoming events from now on or of specific collection if collection in home is set.
You can see examples at:

Parameters

Query Parameters

start

Start timestamp (default: now).

Type
integer
Example1784109600
end

End timestamp (optional).

Type
integer
Example1784109600
query

Search for this string in title, place or tags.

Type
string
Example"test"
tags

List of tags.

Type
array
Example"testtag""testtag2"
place

List of places identifiers.

Type
array
Example2034
show_multidate

Show also multidate events (default: true).

Type
boolean
Examplefalse
show_recurrent

Show also recurrent events (default: as choosen in admin settings).

Type
boolean
Examplefalse
show_federated

Show federated events too.

Type
boolean
Examplefalse
max

Limit events.

Type
integer
Example100
pagination

Pagination.

Type
integer
Example50
older

Select <= start instead of >=.

Type
boolean
Exampletrue
reverse

Reverse order.

Type
boolean
Exampletrue

Responses

List of events.

application/json
JSON
[
  
{
  
  
"id": 1,
  
  
"slug": "event-slug",
  
  
"status": "EventScheduled",
  
  
"title": "Event title",
  
  
"media": [
  
  
  
{
  
  
  
  
"name": "Image name",
  
  
  
  
"url": "6e599b27-5ed8-44c9-b954-53e9c6fa3c80.jpg",
  
  
  
  
"height": 400,
  
  
  
  
"width": 200,
  
  
  
  
"size": 50000,
  
  
  
  
"focalpoint": [
  
  
  
  
  
[
  
  
  
  
  
  
0,
  
  
  
  
  
  
0
  
  
  
  
  
]
  
  
  
  
]
  
  
  
}
  
  
],
  
  
"start_datetime": 1784109600,
  
  
"end_datetime": 1784131200,
  
  
"place": {
  
  
  
"type": "string",
  
  
  
"properties": "string"
  
  
}
  
}
]

Playground

Variables
Key
Value

Samples

Powered by VitePress OpenAPI