Skip to main content
GET
List Fan Voices

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

collection_id
string<uuid>

Only those in this collection, in its order, for a match or show screen. An empty collection gives an empty list; one that's offline, missing or isn't yours answers 404. A collection's ID, a UUID.

Example:

"0192fa7b-8b48-768f-90d1-d3ed6f427962"

status
enum<string>[]

Which statuses to return, comma-separated, such as scheduled,live to show what's coming up as well. live by default. scheduled: coming up, and goes live at starts_at. live: taking votes or messages. closed: taking part has stopped; it can reopen. Experiences your producers take down or delete are never returned.

Available options:
scheduled,
live,
closed
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 Fan Voices: in the collection's order if you filter by collection_id, otherwise newest first.

items
Fan Voice · object[]
required

Fan Voices, in the collection's order or newest created first.

next
string | null
required

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