Skip to main content
GET
/
api
/
v1
/
polls
/
{poll_id}
/
options
/
{id}
Get option
curl --request GET \
  --url https://pollunit.com/api/v1/polls/{poll_id}/options/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "public_url": "<string>",
  "type": "Options::TextOption",
  "admin_url": "<string>",
  "content": "<string>",
  "subtitle": "<string>",
  "description": "<string>",
  "author_name": "<string>",
  "position": 123,
  "state": "<string>",
  "rank": 123,
  "rating": 123,
  "average_rating": 123,
  "best_rating": true,
  "selected": true,
  "child_option_type": "<string>",
  "data": {},
  "input_type": "<string>",
  "options_count": 123,
  "paid": true,
  "privacy_policy_accepted": true,
  "processing": true,
  "rotation": 123,
  "terms_accepted": 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",
  "video_thumb_path": "<string>",
  "vimeo_id": "<string>",
  "youtube_id": "<string>",
  "voter_count": 123,
  "settings": {
    "allowed_values": [
      "<string>"
    ],
    "column_width": 123,
    "dot_vote_icon": 123,
    "mandatory": true,
    "multiline": true,
    "randomize_options": true,
    "require_vote": true,
    "show_as_list": true,
    "survey_step_rating_method": 123,
    "survey_step_vote_limit_per_option": 123,
    "survey_step_vote_limit_per_option_min": 123,
    "survey_step_vote_limit_per_voter": 123,
    "survey_step_vote_type": "<string>",
    "voter_limit": 123
  },
  "approval_state_updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "fraudulent_count": 123,
  "state_change_message": "<string>"
}

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

​
id
integer
required

Option id

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

option found

Full representation of a single poll option. Top-level fields vary by option type and are included conditionally depending on the poll's visibility settings and your access level (admin vs. member); type-specific configuration is grouped under settings.

​
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
​
description
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
​
child_option_type
string | null
​
data
object

Option-type-specific payload (e.g. location_data for location options)

​
drawing_type
enum<string> | null
Available options:
free_sketch,
sign,
draw_on_image
​
input_type
string | null
​
location_type
enum<string> | null
Available options:
point,
route,
polygon,
circle,
rectangle
​
options_count
integer | null
​
paid
boolean | null
​
privacy_policy_accepted
boolean | null
​
processing
boolean | null
​
rotation
integer | null
​
terms_accepted
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
​
video_thumb_path
string | null
​
vimeo_id
string | null
​
youtube_id
string | null
​
voter_count
integer | null
​
settings
object

Option-type-specific configuration, grouped for readability.

​
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

​
fraudulent_count
integer | null

Admin access only

​
state_change_message
string | null

Admin access only