For the complete documentation index, see llms.txt. This page is also available as Markdown.

Web API

Interact with your survey data using our api service

The Zigpoll REST API lets you manage surveys, questions, responses, participants, translations, and webhooks programmatically.

  • Base URL: https://v1.zigpoll.com (not api.zigpoll.com)

  • Authentication: send your API key in the Authorization header. The key on its own and Bearer <key> both work.

  • Plan: API access requires a Premium plan or higher.

  • Roles: your key carries your team role — Read only keys can't write, and webhook/integration endpoints require an API key from an Owner, Admin, or Billing Admin.

Plan errors

A request for an account whose plan doesn't include API access returns HTTP 403 with:

{ "error": "This account's plan does not include API access. Please upgrade to the Premium plan or higher." }

Listing surveys without an accountId skips accounts that don't have API access. If none of your accounts has it, you get:

{ "error": "None of your accounts are on a plan with API access. Please upgrade to the Premium plan or higher." }

Upgrade under Settings → Plans & Limits, or use a key from a login that belongs to an account on an eligible plan.

What you can do

  • Surveys & questions — create, update, list, and duplicate surveys; manage and reorder questions (every question type is supported, including matrix, autocomplete, and phone capture); attach action logic.

  • Responses & participants — list responses, response summaries, and participants; export data.

  • Translations — read and update per-language survey translations.

  • Webhooks — create, list, and delete signed webhooks (requires an API key from an Owner, Admin, or Billing Admin; the signing secret is returned only once, on create).

  • Counters — every survey and account exposes the three counters: responses (surveyResponseCount, the metered unit — one per participant taking a survey), answers (submissionCount, one per question answered), and write-ins (responseCount). See How we calculate responses.

Full reference

Every endpoint, schema, and example is in the official API reference:

https://apidocs.zigpoll.com/

Looking for the in-browser widget API (window.Zigpoll.*) instead? See the Javascript API.

Last updated