Availability
The API is available for spaces on a Pro plan of the cloud hosted version, athttps://api.rallly.co. It is not available on self-hosted instances.
Getting a key
Only the space owner can create API keys, from Settings → API keys. See Authentication for the header format and how keys are handled.Base URL
v1 is stable. Additive changes such as new endpoints or new optional fields may land at any time; breaking changes only arrive under a new version prefix. The changelog records both.
Conventions
- Requests and responses are JSON. Send
Content-Type: application/jsonwith a body. - List endpoints return the items in
data.GET /pollsis paginated: it returns anextCursorbesidedata; pass it as thecursorquery parameter for the next page, and it isnullon the last page.GET /polls/:pollId/participantsreturns every participant in one response. - Timestamps are ISO 8601 instants in UTC. A
datepoll’s options carry a floatingYYYY-MM-DDdate with no timezone; atimepoll’s options carry astartTimeinstant and adurationin minutes. - Request bodies are validated strictly. A field that is not in the schema is rejected rather than ignored, so a misspelt setting never silently falls back to its default.
Machine readable spec
The OpenAPI document that generates this reference is served athttps://api.rallly.co/v1/openapi.