Retrieve a group
curl --request GET \
--url https://api.tightknit.ai/v1/groups/{group_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/groups/{group_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/groups/{group_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/groups/{group_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/groups/{group_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/groups/{group_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/groups/{group_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": "group",
"id": "grup_7m3x9k4t8plz",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"slug": "founding-members",
"visibility": "private",
"description": {},
"description_html": "<string>",
"flair_label": "<string>",
"show_flair": true,
"notify_new_members": true,
"members_count": 1,
"created_by_id": "prof_5Yq7tVz2Hm3n",
"membership_award_id": "awrd_7k3m2p9x4nqr",
"banner_file_id": "file_2b3c4d5e6f7g",
"integrations": {
"slack": {
"channel_id": "C01ABC123"
}
},
"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
}
}
}
},
"membership_award": {
"object": "award",
"id": "awrd_7k3m2p9x4nqr",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"slug": "completion-badge",
"description": {},
"description_html": "<string>",
"default_message": {},
"default_message_html": "<string>",
"requires_approval": true,
"can_be_given_by_non_admin": true,
"created_by_id": "<string>",
"badge_image_file_id": "<string>",
"overlay_frame_image_file_id": "<string>",
"cert_template_image_file_id": "<string>",
"settings": {
"generate_social_share_image": true,
"certificate": {
"show_date": true,
"font_family": "<string>",
"text_color": "#000000"
},
"linkedin": {
"show_add_button": true,
"show_share_button": true,
"prefill_text": "<string>"
}
},
"integrations": {
"slack": {
"announcement_channel_id": "<string>",
"announcement_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
}
}
}
},
"badge_image_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"overlay_frame_image_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"cert_template_image_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
},
"banner_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "<string>",
"param": "<string>",
"request_id": "req_9f2b8c1d4e5a6b7c8d9e0f1a2b3c4d5e"
}Groups
Retrieve a group
Returns one group by its id.
Retrieve a group
curl --request GET \
--url https://api.tightknit.ai/v1/groups/{group_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/groups/{group_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/groups/{group_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/groups/{group_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/groups/{group_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/groups/{group_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/groups/{group_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": "group",
"id": "grup_7m3x9k4t8plz",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"slug": "founding-members",
"visibility": "private",
"description": {},
"description_html": "<string>",
"flair_label": "<string>",
"show_flair": true,
"notify_new_members": true,
"members_count": 1,
"created_by_id": "prof_5Yq7tVz2Hm3n",
"membership_award_id": "awrd_7k3m2p9x4nqr",
"banner_file_id": "file_2b3c4d5e6f7g",
"integrations": {
"slack": {
"channel_id": "C01ABC123"
}
},
"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
}
}
}
},
"membership_award": {
"object": "award",
"id": "awrd_7k3m2p9x4nqr",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"slug": "completion-badge",
"description": {},
"description_html": "<string>",
"default_message": {},
"default_message_html": "<string>",
"requires_approval": true,
"can_be_given_by_non_admin": true,
"created_by_id": "<string>",
"badge_image_file_id": "<string>",
"overlay_frame_image_file_id": "<string>",
"cert_template_image_file_id": "<string>",
"settings": {
"generate_social_share_image": true,
"certificate": {
"show_date": true,
"font_family": "<string>",
"text_color": "#000000"
},
"linkedin": {
"show_add_button": true,
"show_share_button": true,
"prefill_text": "<string>"
}
},
"integrations": {
"slack": {
"announcement_channel_id": "<string>",
"announcement_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
}
}
}
},
"badge_image_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"overlay_frame_image_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"cert_template_image_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
},
"banner_file": {
"object": "file",
"id": "file_2b3c4d5e6f7g",
"name": "cover.png",
"title": "<string>",
"mimetype": "image/png",
"size": 1,
"url": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"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 group's id.
Pattern:
^grup_[a-zA-Z0-9]{12}$Query Parameters
Repeatable. Returns the named relation inline. One of: created_by, membership_award, banner_file.
Available options:
created_by, membership_award, banner_file Response
Success
Always group.
Available options:
group Unique identifier for the object.
Example:
"grup_7m3x9k4t8plz"
When the object was created.
When the object was last changed.
The group’s name.
The group’s path segment in community site URLs.
Example:
"founding-members"
Whether the community site shows the group. One of:
public: listed on the groups page and on its members’ profiles.private: hidden from the community site.
Available options:
private, public What the group is about, as rich text. Rendered on the groups endpoints only; null when the group is nested under another object.
The group’s description as sanitized HTML. Rendered on the groups endpoints only; null when the group is nested under another object.
The short badge text members of the group may show beside their name. Null when the group offers no flair.
Whether the flair appears on posts and comments. It shows only when flair_label is set, the group is public, and the member chose this group’s flair.
Whether members added to the group receive a Slack DM telling them so.
How many members the group has.
Required range:
x >= 0The id of the profile that created the group. Null when no member created it.
Example:
"prof_5Yq7tVz2Hm3n"
The id of the award every member of the group holds while they belong to it. Null when the group grants none.
Example:
"awrd_7k3m2p9x4nqr"
The id of the image shown at the top of the group’s page. Null when the group has no banner.
Example:
"file_2b3c4d5e6f7g"
Where the group connects to other platforms.
Show child attributes
Show child attributes
The profile that created the group. Present only when created_by is expanded.
Show child attributes
Show child attributes
The membership award. Present only when membership_award is expanded.
Show child attributes
Show child attributes
The group’s banner image. Present only when banner_file is expanded.
Show child attributes
Show child attributes
Was this page helpful?