Skip to main content
GET
List vote collections

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

isGeneral
boolean
isGeneral[]
boolean[]
event
string
event[]
string[]
exists[isArchived]
boolean
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[dateStart]
enum<string>
default:asc
Available options:
asc,
desc

Response

200 - application/json

VoteCollection collection

id
integer
read-only
name
string
description
string | null
owner
object
votes
object[]
timezone
string | null
dateCreated
string<date-time>
read-only
dateStart
string<date-time> | null
dateEnd
string<date-time> | null
dateModified
string<date-time> | null
isActive
boolean
default:true
hasPreliminaryResults
boolean | null
default:false
isGeneral
boolean | null
isLocked
boolean | null
default:false
read-only
hideVotersList
boolean | null
default:false
isArchived
boolean | null
unit
object | null
event
object | null
totalVoted
string | null
default:0
totalEligible
string | null
default:0
isOpen
string | null
read-only
isFuture
string | null
read-only
isEditable
boolean | null
hasVoted
boolean | null
default:false
isVoteEligible
boolean | null
default:false
status
string | null
read-only
hasAvailableResults
string | null
read-only
participationPercentage
isDraft
boolean | null
default:true