Skip to content

Get events​

GET
/api/collections/{id}

Get events of a collection by name.

Parameters​

Path Parameters

id*

Name of the collection to get.

Type
string
Required
Example"collection_test"

Query Parameters

start

Start timestamp (default: now).

Type
integer
Example1784109600
end

End timestamp (optional).

Type
integer
Example1784109600
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
limit

Limit events.

Type
integer
Example100
page

Pagination.

Type
integer
Example50
older

Select <= start instead of >=.

Type
boolean
Exampletrue
reverse

Reverse order.

Type
boolean
Exampletrue

Responses​

Events of the collection with name id.

application/json

Playground​

Variables
Key
Value

Samples​

Powered by VitePress OpenAPI