Retrieve a poll
curl --request GET \
--url https://api.tightknit.ai/v1/polls/{poll_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/polls/{poll_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tightknit.ai/v1/polls/{poll_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tightknit.ai/v1/polls/{poll_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tightknit.ai/v1/polls/{poll_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tightknit.ai/v1/polls/{poll_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/polls/{poll_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "poll",
"id": "poll_6r4t8y2u1iop",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"question": "Which day suits the next meetup?",
"description": "<string>",
"allow_multiple_responses": true,
"options": [
{
"object": "poll_option",
"id": "qopt_8k3m1p9x2vqz",
"position": 1,
"label": "Wednesday",
"votes_count": 1
}
],
"status": "open",
"closed_at": "2023-11-07T05:31:56Z",
"scheduled_at": "2023-11-07T05:31:56Z",
"results_visibility": "public",
"voter_identity_visibility": "public",
"results_visible": true,
"responses_count": 1,
"created_by_id": "prof_9f2b8c1d4e5a",
"updated_by_id": "<string>",
"integrations": {
"slack": {
"channel_id": "C01ABC123",
"message_ts": "1788879207.324959",
"message_url": "<string>",
"results_visualization": "ascii_bar",
"channel": {
"object": "slack_channel",
"id": "C01ABC123",
"name": "<string>",
"is_private": true,
"is_archived": true
}
}
},
"created_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
},
"updated_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
}
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "<string>",
"param": "<string>",
"request_id": "req_9f2b8c1d4e5a6b7c8d9e0f1a2b3c4d5e"
}Polls
Retrieve a poll
Returns one poll by its id.
Retrieve a poll
curl --request GET \
--url https://api.tightknit.ai/v1/polls/{poll_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/polls/{poll_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tightknit.ai/v1/polls/{poll_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tightknit.ai/v1/polls/{poll_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tightknit.ai/v1/polls/{poll_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tightknit.ai/v1/polls/{poll_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/polls/{poll_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "poll",
"id": "poll_6r4t8y2u1iop",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"question": "Which day suits the next meetup?",
"description": "<string>",
"allow_multiple_responses": true,
"options": [
{
"object": "poll_option",
"id": "qopt_8k3m1p9x2vqz",
"position": 1,
"label": "Wednesday",
"votes_count": 1
}
],
"status": "open",
"closed_at": "2023-11-07T05:31:56Z",
"scheduled_at": "2023-11-07T05:31:56Z",
"results_visibility": "public",
"voter_identity_visibility": "public",
"results_visible": true,
"responses_count": 1,
"created_by_id": "prof_9f2b8c1d4e5a",
"updated_by_id": "<string>",
"integrations": {
"slack": {
"channel_id": "C01ABC123",
"message_ts": "1788879207.324959",
"message_url": "<string>",
"results_visualization": "ascii_bar",
"channel": {
"object": "slack_channel",
"id": "C01ABC123",
"name": "<string>",
"is_private": true,
"is_archived": true
}
}
},
"created_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
},
"updated_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
}
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "<string>",
"param": "<string>",
"request_id": "req_9f2b8c1d4e5a6b7c8d9e0f1a2b3c4d5e"
}Authorizations
A Tightknit admin API key, sent as Authorization: Bearer <key>.
Path Parameters
The poll's id.
Pattern:
^poll_[a-zA-Z0-9]{12}$Query Parameters
Repeatable. Returns the named relation inline. One of: created_by, updated_by, slack_channel.
Available options:
created_by, updated_by, slack_channel Response
Success
Always poll.
Available options:
poll Unique identifier for the object.
Example:
"poll_6r4t8y2u1iop"
When the poll was created. A scheduled poll is created before it reaches Slack, so this is not when it was posted.
When the poll was last edited, closed, reopened or published. Votes do not move it.
What the poll asks.
Example:
"Which day suits the next meetup?"
Extra context shown under the question. Null for none.
Whether a member may choose several options, rather than their pick replacing the last one.
The options a member chooses between, in the order the poll shows them.
Show child attributes
Show child attributes
Whether the poll takes votes. One of:
open: posted and taking votes.closed: no longer taking votes.scheduled: waiting forscheduled_atto be posted.
Available options:
open, closed, scheduled Example:
"open"
When the poll was closed. Reopening clears it, so it never describes an earlier close.
When a scheduled poll is due to post. It is kept once the poll publishes, so it reads as history rather than as something still pending.
Who may see the tally, and when. Fixed when the poll is created. One of:
public: everyone, at any time.hidden: only whoever created the poll.shown_when_closed: everyone once the poll closes, and only its creator before.
Available options:
public, hidden, shown_when_closed Whether voters are named with their answers. Fixed when the poll is created. One of:
public: voters are named to everyone who sees the results.anonymous: voters are hidden from everyone.confidential: voters are named only to whoever created the poll.
Available options:
public, anonymous, confidential Whether this key may see the tally. False leaves votes_count and responses_count null. An API key counts as nobody, so a poll that only shows its results to its creator withholds them here.
How many responses the poll holds. A poll allowing several answers counts each one, so this is votes rather than voters. Null when results_visible is false.
Required range:
x >= 0The id of the profile that created the poll. Null when no member is recorded as its creator.
Example:
"prof_9f2b8c1d4e5a"
The id of the profile that last changed the poll. Null until it is first changed, or when no member is recorded.
The poll's settings in connected platforms.
Show child attributes
Show child attributes
The profile that created the poll. Present only when created_by is expanded.
Show child attributes
Show child attributes
The profile that last changed the poll. Present only when updated_by is expanded.
Show child attributes
Show child attributes
Was this page helpful?