GET Polls
Get a poll by custom ID
Fetches the poll, choices and optionally can return standing / results depending on state of the poll.
This method requires authentication.
Fetches the poll, choices and optionally can return standing / results depending on state of the poll.
customid: (required) The customid of the poll to fetch.
entities: (optional = "poll"). Provide "poll", "choices", or "results" to get the desired data.
Request
Parameters
Values in the path and query string.
appid path string TalkLabs ID required
The TalkLabs application ID assigned to your account.
Example:your-app-id customid path string customer-defined required
A customer defined ID chosen by your application. TalkLabs stores it so you can retrieve the resource without keeping its TalkLabs ID.
Example:live-event-chat Response
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 Example response · 200
{
"message": "Success",
"errors": {},
"data": {
"kind": "poll.details",
"poll": {
"kind": "poll.poll",
"id": "662da6fbe37d2e9ac76a562b",
"appid": "662bb49bf10e9a26a7e8ed92",
"ownerid": "u-8842",
"title": "Sample Poll 1: Vote for your favorite color",
"description": "Vote for your favorite color",
"posterurl": "",
"embedcontenttop": "",
"embedcontentbotton": "",
"whenpollpublish": "2024-04-28T01:31:39.262Z",
"whenpollopens": "2024-04-28T01:31:39.262Z",
"whenpollcloses": null,
"whenpollexpires": null,
"displayresults": 1,
"sortanswers": 0,
"customtype": "",
"customid": "sample-poll-1-vote",
"custompayload": "",
"customtags": [],
"customfield1": "",
"customfield2": ""
},
"choices": []
}
}