List polls

Owned by Sunita Patro
Last updated: Apr 11, 2023 by Smita Nair
2 min read

List all polls.

  • The response returns code 200 if the invocation is successful else error message is returned. See Error codes.

The operation uses basic authentication.

Resource URL

GET on <ConfluenceBaseURL>/rest/polls/1.0/polls

ConfluenceBaseURL is the URL of your Confluence instance.

Parameters

N/A

Example request

<ConfluenceBaseURL>/rest/polls/1.0/polls

Example response

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

[
{
"name": "Demo2",
"description": "",
"options": [
{
"stringValue": "6:30PM",
"dateValue": "2021-12-01",
"votesCount": 1
}
],
"datePoll": true,
"optionsExtendable": false,
"multipleChoice": true,
"resultsHidden": false,
"pollAnonymous": false,
"votersVisible": true,
"percentsVisible": true,
"votesCountVisible": true,
"nonUserVotesAllowed": false,
"resultsBeforeClosed": true,
"undoAllowed": true,
"tinyUrlEnabled": false,
"participantsCount": 1,
"votesCount": 1,
"guid": "9e38053df8914a33be4a66a450553101"
},
{
"name": "Demo",
"description": "",
"options": [
{
"stringValue": "T1",
"votesCount": 1
},
{
"stringValue": "T2",
"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": "8d15449ee84641faabe01c4bab992174"
},
{
"name": "MakeChoice",
"description": "",
"options": [
{
"stringValue": "Test1",
"votesCount": 1
},
{
"stringValue": "Test2",
"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": "778e25d715354cc8842880b1765e9981"
},
{
"name": "testeventNow",
"description": "",
"options": [
{
"dateValue": "2021-08-19",
"votesCount": 1
}
],
"datePoll": true,
"optionsExtendable": false,
"multipleChoice": true,
"resultsHidden": false,
"pollAnonymous": false,
"votersVisible": true,
"percentsVisible": true,
"votesCountVisible": true,
"nonUserVotesAllowed": false,
"resultsBeforeClosed": true,
"undoAllowed": true,
"tinyUrlEnabled": false,
"participantsCount": 1,
"votesCount": 1,
"guid": "925ec03d84f24bb7bbc0e5fa399a71f9"
},
{
"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"
},
{
"name": "Test poll now copy",
"description": "",
"options": [
{
"stringValue": "Product Xc",
"votesCount": 0
},
{
"stringValue": "Product Yc",
"votesCount": 1
},
{
"stringValue": "Product Zc",
"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": "9ce8c5f8295b46528274daec8d057ae7"
},
{
"name": "testevent",
"description": "",
"options": [
{
"dateValue": "2021-08-19",
"votesCount": 0
}
],
"datePoll": true,
"optionsExtendable": false,
"multipleChoice": true,
"resultsHidden": false,
"pollAnonymous": false,
"votersVisible": true,
"percentsVisible": true,
"votesCountVisible": true,
"nonUserVotesAllowed": false,
"resultsBeforeClosed": true,
"undoAllowed": true,
"tinyUrlEnabled": false,
"participantsCount": 1,
"votesCount": 1,
"guid": "02a7a0e361ae41308a74b860c955a255"
},
{
"name": "Test poll now",
"description": "",
"options": [
{
"stringValue": "Product X",
"votesCount": 0
},
{
"stringValue": "Product Y",
"votesCount": 0
},
{
"stringValue": "Product Z",
"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": 0,
"votesCount": 0,
"guid": "3961c621f00a484fbdc7983a0dc7adf6"
}
]

Error codes

Code

Cause of error

Message displayed

Code

Cause of error

Message displayed

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.

Â