Skip to main content
GET
/
api
/
v1
/
polls
/
{poll_id}
/
options
List poll options
curl --request GET \
  --url https://pollunit.com/api/v1/polls/{poll_id}/options \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "public_url": "<string>",
    "type": "Options::TextOption",
    "admin_url": "<string>",
    "content": "<string>",
    "subtitle": "<string>",
    "author_name": "<string>",
    "position": 123,
    "state": "<string>",
    "rank": 123,
    "rating": 123,
    "average_rating": 123,
    "best_rating": true,
    "selected": true,
    "paid": true,
    "info_link": "<string>",
    "info_link_title": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "approval_state_updated_at": "2023-11-07T05:31:56Z",
    "archived": true
  }
]

Authorizations

​
Authorization
string
header
required

Personal API token — find yours under My Account → API.

Path Parameters

​
poll_id
string
required

Poll member_hash or admin_hash

Query Parameters

​
organization_id
string

public_id of an organization the user belongs to. When given, the request runs in that organization context instead of the personal account.

Response

options listed

​
id
string
required

Option public_id

​
public_url
string<uri>
required
​
type
string
required

Option STI class

Example:

"Options::TextOption"

​
admin_url
string<uri> | null

Admin access only

​
content
string | null
​
subtitle
string | null
​
author_name
string | null
​
position
integer | null
​
state
string | null
​
rank
integer | null
​
rating
number<float> | null
​
average_rating
number<float> | null
​
best_rating
boolean | null
​
selected
boolean | null
​
paid
boolean | null
​
info_link
string | null
​
info_link_title
string | null
​
start_date
string<date-time> | null
​
end_date
string<date-time> | null
​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null
​
approval_state
enum<string> | null

Admin access only

Available options:
unreviewed,
approved,
disapproved
​
approval_state_updated_at
string<date-time> | null

Admin access only

​
archived
boolean | null

Admin access only