Skip to content
WhiteBeard

List polls

GET
/cms/poll
curl --request GET \
  --url https://api.example.com/cms/poll \
  --header 'API-Key: <API-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
limit
integer

Responses

Section titled “Responses”

200

Section titled “200”

List of polls

Media typeapplication/json
Array<object>
Poll

API representation of a poll

object
id

Poll ID

integer format: int64
timestamp

Timestamp

string
question

Question

string
choices

Choices

Array<string>
votes

Votes

integer
slug

Slug

string
category
PollCategory

API representation of a poll category

object
id

Category ID

integer format: int64
name

Name

string
image

Image

string
results

Results

Array<object>
object
value

Number of votes

integer format: int64
percentage

Percentage of total votes

number format: float
message

Message

string
onlyLoggedIn

Only logged in

integer
endDate

End date

string
nullable
voted

Voted (only true when voting)

boolean
voted_choice

Voted choice (only valid when voting)

integer
closed

Closed

integer

Example generated

[
  {
    "id": 1,
    "timestamp": "example",
    "question": "example",
    "choices": [
      "example"
    ],
    "votes": 1,
    "slug": "example",
    "category": {
      "id": 1,
      "name": "example"
    },
    "image": "example",
    "results": [
      {
        "value": 1,
        "percentage": 1
      }
    ],
    "message": "example",
    "onlyLoggedIn": 1,
    "endDate": "example",
    "voted": true,
    "voted_choice": 1,
    "closed": 1
  }
]