Skip to main content
GET
Get a poll with its results

Authorizations

x-api-key
string
header
required

Which app is calling, and its usage plan: a platform's secret key, from servers only, or an app's publishable key (pk_live_...), safe in app code. It identifies the app and grants nothing on its own.

Authorization
string
header
required

A platform's short-lived issuer token, for the same client as the key.

Path Parameters

poll_id
string
required
Pattern: ^pol_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9"

Response

The item, any status including deleted.

Poll, results included.

id
string
required
Pattern: ^pol_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9"

name
string | null
required
experience_id
string
required
Pattern: ^exp_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"exp_01JBX7Q2T8M4K9R6V3N5P0WZCD"

status
enum<string>
required

The item's status: values are added, never removed. scheduled: waits for starts_at, then goes live. live: taking votes. hidden: not shown to fans; the state underneath is kept, so making it live or closed again restores it. closed: votes have stopped. deleted: retired; reads still return it, with this status.

Available options:
scheduled,
live,
hidden,
closed,
deleted
starts_at
string<date-time> | null
required

When it opens. Null when it opens on demand.

ends_at
string<date-time> | null
required

When it closes. Null otherwise.

metadata
object
required

Free-form tags: up to 50 keys of up to 40 characters, values up to 500. One reserved key, event_id: the event the item is about. Every other key is yours, and never interpreted.

api_version
integer
required
read-only

The major version of the widget type's own API, kept for the item's life.

Required range: x >= 1
created_at
string<date-time>
required

RFC 3339, in UTC.

updated_at
string<date-time>
required

RFC 3339, in UTC.

type
any
required
results_visibility
enum<string>
default:after_vote
required

When fans may see results: live, after_vote, after_close (once votes have stopped) or hidden. Platform reads always include them; fan app reads hold them back until the item closes, unless live.

Available options:
live,
after_vote,
after_close,
hidden
total_votes
integer | null
required

Fans who voted. Null until the first result.

Required range: x >= 0
final
boolean
required

True once votes have stopped and been recounted: the official result.

requires_sign_in
boolean
required
question
string
required

The question fans answer.

Required string length: 1 - 300
options
object[]
required
subtitle
string

Supporting text under the question.

Maximum string length: 300