Retrieve a calendar event
curl --request GET \
--url https://api.tightknit.ai/v1/events/{event_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/events/{event_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/events/{event_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/events/{event_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/events/{event_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/events/{event_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/events/{event_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": "event",
"id": "cevt_4h2o89z6qlpw",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"slug": "<string>",
"status": "draft",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"show_end_date": true,
"description": {},
"description_html": "<string>",
"recap": {},
"recap_html": "<string>",
"location": "<string>",
"link": "<string>",
"recording_link": "<string>",
"external_speakers": "<string>",
"webhook_custom_metadata": "<string>",
"cover_image_file_id": "file_2b3c4d5e6f7g",
"is_unlisted": true,
"publish_to_site": true,
"allow_public_guest_list": true,
"enable_registration_button": true,
"use_registration_btn_as_link": true,
"triggers_webhooks": true,
"reminders_config": [
{
"minutes": 1
}
],
"created_by_id": "prof_5Yq7tVz2Hm3n",
"integrations": {
"luma": {
"event_id": "<string>"
},
"slack": {
"published_channels": [
{
"object": "event_published_channel",
"channel_id": "C01ABC123",
"channel_name": "<string>",
"message_permalink": "<string>",
"feed_id": "feed_7Kd2mQx4Lp9v"
}
]
}
},
"cover_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"
},
"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
}
}
}
},
"tag_links": [
{
"object": "event_tag",
"id": "evtg_4h2o89z6qlpw",
"created_at": "2023-11-07T05:31:56Z",
"tag_id": "tags_4h2o89z6qlpw",
"tag": {
"object": "tag",
"id": "tags_4h2o89z6qlpw",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"slug": "<string>",
"section": "format",
"description": "<string>",
"tag_group_id": "tgrp_4h2o89z6qlpw",
"created_by_id": "prof_5Yq7tVz2Hm3n",
"updated_by_id": "prof_5Yq7tVz2Hm3n",
"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"
}Events
Retrieve a calendar event
Returns one calendar event by its id.
Retrieve a calendar event
curl --request GET \
--url https://api.tightknit.ai/v1/events/{event_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/events/{event_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/events/{event_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/events/{event_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/events/{event_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/events/{event_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/events/{event_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": "event",
"id": "cevt_4h2o89z6qlpw",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"slug": "<string>",
"status": "draft",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"show_end_date": true,
"description": {},
"description_html": "<string>",
"recap": {},
"recap_html": "<string>",
"location": "<string>",
"link": "<string>",
"recording_link": "<string>",
"external_speakers": "<string>",
"webhook_custom_metadata": "<string>",
"cover_image_file_id": "file_2b3c4d5e6f7g",
"is_unlisted": true,
"publish_to_site": true,
"allow_public_guest_list": true,
"enable_registration_button": true,
"use_registration_btn_as_link": true,
"triggers_webhooks": true,
"reminders_config": [
{
"minutes": 1
}
],
"created_by_id": "prof_5Yq7tVz2Hm3n",
"integrations": {
"luma": {
"event_id": "<string>"
},
"slack": {
"published_channels": [
{
"object": "event_published_channel",
"channel_id": "C01ABC123",
"channel_name": "<string>",
"message_permalink": "<string>",
"feed_id": "feed_7Kd2mQx4Lp9v"
}
]
}
},
"cover_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"
},
"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
}
}
}
},
"tag_links": [
{
"object": "event_tag",
"id": "evtg_4h2o89z6qlpw",
"created_at": "2023-11-07T05:31:56Z",
"tag_id": "tags_4h2o89z6qlpw",
"tag": {
"object": "tag",
"id": "tags_4h2o89z6qlpw",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"slug": "<string>",
"section": "format",
"description": "<string>",
"tag_group_id": "tgrp_4h2o89z6qlpw",
"created_by_id": "prof_5Yq7tVz2Hm3n",
"updated_by_id": "prof_5Yq7tVz2Hm3n",
"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 calendar event's id.
Pattern:
^cevt_[a-zA-Z0-9]{12}$Query Parameters
Repeatable. Returns the named relation inline. One of: cover_image_file, created_by, tag_links, slack_channels.
Available options:
cover_image_file, created_by, tag_links, slack_channels Response
Success
Always event.
Available options:
event Unique identifier for the object.
Example:
"cevt_4h2o89z6qlpw"
When the object was created.
When the object was last changed.
The event title.
The URL segment of the event's page on the community site.
Where the event is in its life cycle. One of:
draft: saved but not live. A published event moved back to draft keeps the Slack announcements it already had.needs_approval: submitted and waiting for an admin to approve it. Visible only to its creator and admins.published: live: announced in its Slack channels and, whenpublish_to_siteis on, shown on the community site.cancelled: called off. Visible only to its creator and admins.
Available options:
draft, needs_approval, published, cancelled When the event starts.
When the event ends.
Whether the end date is displayed beside the start date in Slack and on the community site. A hidden end date still ends the event.
The event description as a rich text document. Rendered on the events endpoints only; null when the event is nested under another object.
The event description as sanitized HTML. Rendered on the events endpoints only; null when the event is nested under another object.
A recap written after the event, as a rich text document. Rendered on the events endpoints only; null when the event is nested under another object.
The recap as sanitized HTML. Rendered on the events endpoints only; null when the event is nested under another object.
Where the event takes place, as free text. Null when not set.
The event's URL, such as a video-call or registration link. Null when not set.
A link to the event's recording. Null when not set.
Speakers who are not community members, as free text displayed with the event. Null when there are none.
Passed through as custom_metadata on the calendar_event.published, calendar_event.user_registered and calendar_event.user_unregistered webhook payloads so the receiver can match it to its own record. Null when not set.
The id of the event's cover image file. Null when the event has no cover image.
Example:
"file_2b3c4d5e6f7g"
Whether the event is hidden from event listings.
Whether the event shows on the community site. The site only shows published events, so on a draft this records where it goes once published.
Whether the attendee list and registrant count are shown to members who are neither admins nor the event owner, on the community site and in Slack.
Whether the event shows a registration button members click to sign up, with their attendance tracked in Tightknit.
Whether the registration button sends members to the event link instead of registering them in Tightknit, for sign-ups handled elsewhere.
Whether the event sends payloads to the community's subscribed webhooks when it is published, when it ends, and as members register and unregister.
The reminders sent as Slack direct messages to the event's hosts, speakers and registrants. Only a published event sends them.
Show child attributes
Show child attributes
The id of the member who created the event. Null when no member is recorded as its creator.
Example:
"prof_5Yq7tVz2Hm3n"
What the event looks like in the services it is connected to.
Show child attributes
Show child attributes
The cover image file. Present only when cover_image_file is expanded.
Show child attributes
Show child attributes
The member who created the event. Present only when created_by is expanded.
Show child attributes
Show child attributes
The tags on the event. Present only when tag_links is expanded.
Show child attributes
Show child attributes
Was this page helpful?