Skip to main content
GET
/
api
/
v1
/
polls
List polls
curl --request GET \
  --url https://pollunit.com/api/v1/polls \
  --header 'Authorization: Bearer <token>'
[
  {
    "public_url": "<string>",
    "member_hash": "<string>",
    "title": "<string>",
    "type": "Polls::Voting",
    "admin_url": "<string>",
    "admin_hash": "<string>",
    "description": "<string>",
    "location": "<string>",
    "options_count": 123,
    "voters_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "settings": {
      "access_by_provider": 123,
      "additional_attributes": {},
      "additional_option_attributes": {},
      "advent_calendar_shape": 123,
      "allow_attachments": true,
      "allow_change_sort": true,
      "allow_comments": true,
      "allow_description": true,
      "allow_group_submissions": true,
      "allow_info_link": true,
      "allow_new_options": true,
      "allow_new_rows": true,
      "allow_search": true,
      "allow_share": true,
      "allow_subtitle": true,
      "allow_voting": true,
      "allowed_hosts": [
        "<string>"
      ],
      "anonymize_voter_names": true,
      "custom_hash": true,
      "deadline_submission": "2023-11-07T05:31:56Z",
      "deadline_voting": "2023-11-07T05:31:56Z",
      "default_sort": "<string>",
      "default_states": "<array>",
      "disable_participant_sign_up": true,
      "dot_vote_icon": "<string>",
      "effect": 123,
      "file_size_max_mb": 123,
      "file_size_min_mb": 123,
      "forward_url_parameters": true,
      "group_submission_max_entries": 123,
      "hidden_author_name": true,
      "hidden_best_rating": true,
      "hidden_image_name": true,
      "hidden_participants": true,
      "hide_options": true,
      "hide_results": true,
      "hide_tags": true,
      "hide_votes": true,
      "image_min_height": 123,
      "image_min_smallest_side_length": 123,
      "image_min_width": 123,
      "image_orientation": "<string>",
      "indexing": true,
      "jury_mode": true,
      "limit_per_option": 123,
      "limit_per_option_type": "<string>",
      "notify_new_options": true,
      "option_limit": 123,
      "option_type": "<string>",
      "options_per_page": 123,
      "options_visible_before_voting": true,
      "participant_limitation_type": "<string>",
      "photo_gallery_full_width": true,
      "photo_gallery_image_mode": 123,
      "photo_gallery_layout": 123,
      "prevent_vote_for_own_options": true,
      "privacy_policy": "<string>",
      "privacy_policy_for_option_creators": true,
      "privacy_policy_for_voters": true,
      "private_comments": true,
      "public_admin_link": true,
      "publisher": "<string>",
      "publisher_email": "<string>",
      "publisher_info": "<string>",
      "randomize_options": true,
      "rating_method": "<string>",
      "require_approval": true,
      "require_author_name": true,
      "require_description": true,
      "require_voter_name": true,
      "restrict_view_access": true,
      "restricted_double_opt_in_domains": "<array>",
      "show_as_list": true,
      "show_metadata": true,
      "show_photo_info_by_default": true,
      "single_select": true,
      "social_media_description": "<string>",
      "social_media_image_data": {},
      "social_media_title": "<string>",
      "start_date_submission": "2023-11-07T05:31:56Z",
      "start_date_voting": "2023-11-07T05:31:56Z",
      "submission_fee": 123,
      "submission_fee_title": "<string>",
      "submission_fee_type": 123,
      "target": "<string>",
      "terms": "<string>",
      "terms_for_option_creators": true,
      "terms_for_voters": true,
      "thank_you_page": true,
      "thank_you_page_data": {},
      "thank_you_page_submitter": true,
      "thank_you_page_submitter_data": {},
      "timezone": "<string>",
      "vote_limit_per_option": 123,
      "vote_limit_per_option_min": 123,
      "vote_limit_per_voter": 123,
      "vote_per_day": true,
      "vote_type": "<string>",
      "voting_fee": 123,
      "voting_fee_title": "<string>",
      "voting_fee_type": 123,
      "white_label": true
    },
    "configuration_hints": {}
  }
]

Authorizations

Authorization
string
header
required

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

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

polls listed

public_url
string<uri>
required
member_hash
string
required

Public poll identifier (use for read/submit)

title
string
required
type
string
required
Example:

"Polls::Voting"

status
enum<string>
required
Available options:
active,
closed
admin_url
string<uri> | null

Admin URL (owner/admin access only)

admin_hash
string | null

Admin identifier (only returned to owner)

description
string | null
location
string | null
options_count
integer
voters_count
integer | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
url
string<uri>
settings
object
configuration_hints
object

Allowed values for selected configuration fields (owner/admin only)