canonical: https://jentic.com/apis/crowdsignal.com/crowdsignal

# Crowdsignal API

Jentic publishes the only available OpenAPI specification for Crowdsignal API, keeping it validated and agent-ready. Crowdsignal is an Automattic-owned polls, ratings, and surveys product, popular with WordPress publishers. The API exposes 16 POST endpoints for creating, updating, listing, and deleting polls, collecting and resetting votes, retrieving comments, moderating comments, and managing account and folder metadata. Authentication is by partnerGUID query parameter rather than an Authorization header.

## For AI agents

Create polls, collect votes, retrieve results, and moderate comments on the Crowdsignal polling platform.

## Scope

Does not handle long-form survey logic, conjoint analysis, or panel recruitment - use for Crowdsignal polls, ratings, and basic comment moderation only.

## Capabilities

- Create new polls and update existing poll configurations via /CreatePoll and /UpdatePoll
- Retrieve poll results in aggregate or per-vote via /GetPollResults and /GetPollVotes
- Reset poll results to start a fresh data collection round
- List and moderate poll comments using /GetPollComments and /ModerateComment
- Register a vote on a poll programmatically with /Vote
- Manage account-level metadata and folders via /GetAccount, /UpdateAccount, and /GetFolders

## Use cases

### Programmatic Poll Creation for Editorial Workflows

Auto-publish polls alongside articles in a CMS by calling POST /CreatePoll with the question and answer set, then embedding the returned poll into the article body. Editorial ops teams use this to remove the manual UI step from a high-frequency publishing flow, and POST /UpdatePoll handles late edits to either the question or the answer choices.

Example prompt: Create a Crowdsignal poll with question 'Which release notes feature stands out?' and three answer choices, returning the poll ID

### Vote and Comment Aggregation

Aggregate poll results into a reporting dashboard by polling /GetPollResults at regular intervals and pulling per-vote breakdowns through /GetPollVotes. Editorial and audience-research teams use this to push poll data into BI tools, and /GetPollComments plus /ModerateComment let a moderator clean up spam without touching the Crowdsignal UI.

Example prompt: Fetch results for poll ID 12345 via /GetPollResults and reject any pending comments via /ModerateComment whose body contains a banned word

### Multi-Property Polling Account Management

Manage a single Crowdsignal account that powers polls across many properties by listing folders with /GetFolders and updating account-level settings via /UpdateAccount. Larger publishers organise polls by property or campaign through folders so reporting stays clean.

Example prompt: List Crowdsignal folders and update the account email address to ops@example.com

### AI Agent Survey Result Summaries

An AI agent assembles a Monday-morning summary of the prior week's poll activity by calling Crowdsignal through Jentic. The agent searches for the crowdsignal_get_poll_results operation, executes against the team's vaulted partnerGUID, and joins the results with poll titles to produce a markdown summary. Jentic injects the partnerGUID query parameter so the agent never sees the raw key.

Example prompt: Use the Jentic SDK to fetch results for every poll created in the last 7 days and summarise top-voted answers per poll

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/CreatePoll` | Create a new poll |
| POST | `/UpdatePoll` | Update an existing poll |
| POST | `/GetPollResults` | Retrieve aggregated poll results |
| POST | `/GetPollVotes` | Retrieve individual poll votes |
| POST | `/Vote` | Register a vote on a poll |
| POST | `/GetPollComments` | Retrieve comments on a poll |
| POST | `/ModerateComment` | Approve or reject a comment |

## Key resources

- **Polls** — Create, update, list, retrieve, and delete polls via /CreatePoll, /UpdatePoll, /GetPolls, /GetPoll, and /DeletePoll
- **Results and Votes** — Get aggregated results, list individual votes, reset results, and register a vote via /GetPollResults, /GetPollVotes, /ResetPollResults, and /Vote
- **Comments** — Retrieve comments and moderate them via /GetPollComments and /ModerateComment
- **Account** — Account and folder management via /GetAccount, /UpdateAccount, /GetFolders, and bootstrap endpoints /pdInitiate and /GetUserCode

## Why Jentic

- **Setup:** Wiring Crowdsignal by hand means appending its partnerGUID as a query parameter on every request and posting poll, vote, and comment payloads yourself. Through Jentic you install once, import Crowdsignal from the API Directory, store the partnerGUID once, and your agent calls it.
- **Permission scoping:** Crowdsignal identifies the poll in the request body rather than the URL path, so limit the agent to the operations it needs, such as creating a poll or reading poll results. You choose the operations it may call, so ModerateComment or Vote is not included unless you add it.
- **Credential handling:** Your Crowdsignal partnerGUID is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Crowdsignal poll' or 'get poll results', and Jentic returns the matching Crowdsignal operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **crowd.dev API** — crowd.dev tracks community activity that can include responses to Crowdsignal polls
- **Crove API** — Crove generates documents that can summarise Crowdsignal poll results into a templated report
- **Cron-job.org API** — cron-job.org schedules recurring HTTP calls into Crowdsignal for periodic results sync

## FAQ

### Why is there no official OpenAPI spec for Crowdsignal API?

Crowdsignal does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Crowdsignal API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Crowdsignal API use?

The Crowdsignal API authenticates via a partnerGUID query parameter rather than a header - your API key is appended to each request as ?partnerGUID=YOUR_KEY. Through Jentic the partnerGUID is held encrypted in the vault and Jentic appends it at request time so it never enters the agent's context.

### Can I create a poll and retrieve its results through the API?

Yes. POST /CreatePoll creates a poll, and POST /GetPollResults returns aggregated results for a poll ID, while POST /GetPollVotes returns the per-vote breakdown for analysis.

### How do I create a poll through Jentic?

Search Jentic for 'create a Crowdsignal poll', load the operation schema for POST /CreatePoll, and execute with the question and answer set. Jentic appends the partnerGUID query parameter automatically.

### How many endpoints does the Crowdsignal API expose?

Sixteen POST endpoints covering polls, votes, results, comments, comment moderation, accounts, folders, and the /pdInitiate and /GetUserCode bootstrap calls.

### Can I moderate poll comments through the API?

Yes. POST /GetPollComments lists comments on a poll and POST /ModerateComment approves or rejects a specific comment, so a moderation pipeline can run without using the Crowdsignal UI.

### Can I limit what my agent is allowed to do with the Crowdsignal API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which Crowdsignal operations your agent may call, so you can grant only what it needs, such as CreatePoll and GetPollResults. Since Crowdsignal identifies the poll in the request body rather than the URL path, higher-impact operations like ModerateComment or Vote are not available to the agent unless you explicitly add them. The stored partnerGUID stays under your control and is injected at request time, so the agent never handles the raw key.
