List Polls
Rooms can be public or private.
This method requires authentication.
Rooms can be public or private. This method lists all public rooms that everyone can see.
cursor : (optional) The first time you call list rooms, omit this property to start from the beginning. Call the method again passing in the value returned in the cursor field of the response to get the next page of results. If there are more results available, more will be true.
limit : (optional) Specify the number of items to return. Default is 200.
includeUnpublished: (optional: false). If set to true, the function will include polls that are not yet published. Requires createpoll permission.
Parameters
Values in the path and query string.
appid path The TalkLabs application ID assigned to your account.
Example:your-app-id IncludeUnpublished query false limit query The maximum number of records to return.
Example:200 cursor query The cursor returned by the previous page.
Status codes
Every JSON response uses the API result envelope.
200 OK ApiResult 400 Bad Request ApiResult 403 Forbidden ApiResult 500 Internal Server Error ApiResult {
"message": "Success",
"errors": {},
"data": {
"kind": "list.poll.responses",
"cursor": "",
"more": false,
"itemcount": 1,
"choices": [
{
"kind": "poll.poll",
"id": "663fae9abe2ce30d3d6c428c",
"appid": "662bb49bf10e9a26a7e8ed92",
"ownerid": "u-8842",
"title": "Which is the best model of the show?",
"description": "Vote for your favorite model",
"posterurl": "",
"embedcontenttop": "",
"embedcontentbotton": "",
"whenpollpublish": "2024-05-11T17:44:58.705Z",
"whenpollopens": "2024-05-11T17:44:58.705Z",
"whenpollcloses": "9999-12-31T23:59:59.9999999Z",
"whenpollexpires": "9999-12-31T23:59:59.9999999Z",
"displayresults": 1,
"sortchoices": 0,
"maxtotalresponsesperuser": 10,
"allowmultiplechoicesperuser": true,
"maxvotesperchoiceperuser": 5,
"customtype": "",
"customid": "miamitape-atlsw-2024",
"custompayload": "",
"customtags": [],
"customfield1": "",
"customfield2": ""
}
]
}
}