Lists the poll with given poll id.

  • The response returns code 200 if the poll creation 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

Sample request payload to create a choice poll

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

Example response

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

Sample response after successful execution of request

{
"status": "200",
"Poll": {
"guid": "f2945cb488a341198bb7ecf173f5db07",
"name": "Choice poll - What product do you like best?",
"resultsHidden": false,
"closed": false,
"open": true,
"datePoll": false,
"multipleChoice": false,
"pollAnonymous": true,
"votersVisible": false,
"nonUserVotesAllowed": false,
"resultsBeforeClosed": false,
"undoAllowed": false,
"tinyUrlEnabled": false,
"optionsExtendable": false,
"percentsVisible": false,
"votesCountVisible": false
}
}

Error codes

Code

Cause of error

Message displayed

404

when poll with given poll guid in 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.