Get poll

Owned by Aparna Mokkapati
Last updated: Apr 11, 2023 by Smita Nair
1 min read

Displays the poll using the provided poll ID.

  • The response returns code 200 if the poll retrieval was successful else error messages are generated. See Error codes.

The operation uses basic authentication.

Resource URL

GET on <ConfluenceBaseURL>/rest/polls/1.0/poll/{pollguid}

ConfluenceBaseURL is the URL of your Confluence instance.

Parameters

The URL parameter should be replaced with GUID of the poll.

  • pollguid - GUID of the poll

Example request

<ConfluenceBaseURL>/rest/polls/1.0/poll/f2945cb488a341198bb7ecf173f5db07

Example response

See Parameters to learn more about response parameters of both choice and event polls.

{
"status":"200",
"Poll":{
"name":"Testing upliftment ?",
"description":"Test ",
"options":[
{
"stringValue":"YES",
"votesCount":1
},
{
"stringValue":"NO",
"votesCount":0
}
],
"datePoll":false,
"optionsExtendable":false,
"multipleChoice":false,
"resultsHidden":false,
"pollAnonymous":false,
"votersVisible":true,
"percentsVisible":true,
"votesCountVisible":true,
"nonUserVotesAllowed":false,
"resultsBeforeClosed":true,
"undoAllowed":true,
"tinyUrlEnabled":false,
"participantsCount":1,
"votesCount":1,
"guid":"ab21366031624a68a569b25faab7ba7b"
}
}

Error codes

Code

Cause of error

Message displayed

Code

Cause of error

Message displayed

404

Poll with given poll GUID is not found.

Operation failed with error poll not found.

403

User is not permitted to perform a particular operation.

Operation failed with error not allowed.

401

Invalid user credentials.

Operation failed with error unauthorized.