Get option
Authorizations
Personal API token — find yours under My Account → API.
Path Parameters
Poll member_hash or admin_hash
Option public_id, as returned in the id field
Query Parameters
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.
Option public_id
Option STI class
"Options::TextOption"
Admin access only
Collection polls only
incoming, investigation, planned, in_implementation, rejected, done Option-type-specific payload (e.g. location_data for location options)
free_sketch, sign, draw_on_image Input options only
text, textarea, email, url, select, radio, multi_select, checkbox, number, number_float, file, date, datetime point, route, polygon, circle, rectangle Option-type-specific configuration, grouped for readability.
URLs of the file uploaded to the option, returned by both the list and the show endpoint. Only present for option types that carry an uploaded file (image, photo, audio, drawing and advent calendar options); youtube/vimeo and uploaded-video options do not have it. The attachment_url_* keys are the processed derivatives that exist for this file, so which ones are returned depends on the uploaded file: images and videos get large, thumb and social, an audio file only gets cover if it has embedded cover art, and a file that is still processing has none at all. The whole object is omitted when none of its keys apply, e.g. an option without a file or a still-processing upload you have no download access to.
Admin access only
unreviewed, approved, disapproved Admin access only
Admin access only
Admin access only
Admin access only