Skip to main content
GET
List collections

Authorizations

x-api-key
string
header
required

Your organisation's API key, supplied by Dizplai. Send it on every request. It isn't a secret, so it can ship in your app: what a fan does is protected by the fan's token.

Query Parameters

metadata
object

Filter by tags, such as metadata[event_id]=ev_2041 for one match or show. Any other tag key works the same way. An exact match; with several keys, all must match.

after
string

Where the next page starts, the next value from the previous page. Leave it out for the first page.

limit
integer
default:50

How many items a page holds, 1 to 100. 50 by default.

Required range: 1 <= x <= 100

Response

A page of collections, newest first. To list a collection's experiences, filter List experiences by its collection_id.

items
object[]
required

Collections, newest created first.

next
string | null
required

Pass as after for the next page. Null on the last page.