Poll results

Workforce module

GET/polls/{id}/resultspolls.results

Votes per option. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability knowledge.sop.read.
OAuth scopes: knowledge.
Error statuses: 400, 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

polls.results: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the poll.

Response 200: PollResultPage

polls.results: PollResultPage
Field	Type	Required	Description
data	array of PollResult	Yes	Items on this page, in the documented default order.
next_cursor	string \| null	Yes	Opaque cursor for the next page; null on the last page.

{
  "data": [
    {
      "poll_option_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "option_position": 1,
      "label": "Tacos",
      "votes": 12,
      "voters": 20
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/polls/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/results" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.polls.results("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.polls.results("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos polls results 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f