beehiiv Developer Documentation

{
  "data": {
    "id": "poll_00000000-0000-0000-0000-000000000000",
    "name": "Favorite Color",
    "question": "What is your favorite color?",
    "poll_type": "voting",
    "status": "published",
    "created_at": 1666800076,
    "poll_choices": [
      {
        "id": "00000000-0000-0000-0000-000000000001",
        "label": "Red"
      },
      {
        "id": "00000000-0000-0000-0000-000000000002",
        "label": "Blue"
      },
      {
        "id": "00000000-0000-0000-0000-000000000003",
        "label": "Green"
      }
    ],
    "description": "Choose an answer from the list below."
  }
}

Retrieve detailed information about a specific poll belonging to a publication. Use expand[]=stats for aggregate vote counts, or expand[]=poll_responses for individual subscriber responses.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

pollIdstringRequiredformat: "^(poll_[0-9a-fA-F\-]+)$"

The prefixed ID of the poll object

Query parameters

expand[]list of enumsOptional

Optionally expand the response to include additional data.
stats - Returns aggregate vote counts per choice and total completions.
poll_responses - Returns up to 10 most recent subscriber responses. Use /polls/{pollId}/responses for paginated access to all responses.
trivia_answer - Returns the correct answer for trivia-type polls.

Allowed values:

Response

dataobject

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error