Get collections

GET

/api/collections

Get collections.

Parameters

Query Parameters

withFilters

Indicates if including filters in the response or not (used in admin panel).

Type

boolean

Exampletrue

pin

Only retrieve collections that are pinned (used in homepage).

Type

boolean

Exampletrue

Responses

Events of the collection with name id.

Content-Type

application/json

[

  

{

  

  

"id": 2,

  

  

"name": "Collection name",

  

  

"isActor": false,

  

  

"isTop": false,

  

  

"sortIndex": 12,

  

  

"createdAt": "2020-01-29T18:10:16.630Z",

  

  

"updatedAt": "2020-01-30T22:42:14.789Z"

  

}

]

GET

/api/collections

Playground

Variables

Key

Value

withFilters

pin

Samples

Powered by VitePress OpenAPI