List poll options
Returns one page of options. The options have a hierarchy with varying levels. API calls can navigate through this hierarchy by passing a parent_option_id. The default page size depends on the poll type and the poll’s options_per_page setting; use the X-Total-Pages / X-Total-Count response headers to page through the full list.
Authorizations
Personal API token — find yours under My Account → API.
Path Parameters
Poll member_hash or admin_hash
Query Parameters
Public ID of parent option id, to list its child options.
Page to return, 1-based. Defaults to 1.
Options per page. Defaults to the page size of the poll type. At most 100.
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
Option public_id
Option STI class
"Options::TextOption"
Admin access only
Collection polls only
incoming, investigation, planned, in_implementation, rejected, done Admin access only
unreviewed, approved, disapproved Admin access only
Admin access only
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.