> For the complete documentation index, see [llms.txt](https://docs.zigpoll.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zigpoll.com/web-api.md).

# Web API

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

* **Base URL:** `https://v1.zigpoll.com`
* **Authentication:** send your [API key](/integrations/api-key.md) in the `Authorization` header.
* **Plan:** API access requires an **Advanced** plan or higher.
* **Roles:** your key carries your team role — Read only keys can't write, and webhook/integration endpoints require an admin-tier key.

### 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](/integrations/webhooks.md) (admin-tier key required; the signing secret is returned only once, on create).
* **Counters** — every survey and account exposes the three metering counters: responses, submissions, and open-ended responses. See [How we calculate responses](/subscription-plans/how-we-calculate-responses.md).

### Full reference

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

<https://apidocs.zigpoll.com/>

{% hint style="info" %}
Looking for the in-browser widget API (`window.Zigpoll.*`) instead? See the [Javascript API](/javascript-api.md).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zigpoll.com/web-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.