Retrieve a journey
curl --request GET \
--url https://api.tightknit.ai/v1/journeys/{journey_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/journeys/{journey_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/journeys/{journey_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/journeys/{journey_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/journeys/{journey_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/journeys/{journey_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/journeys/{journey_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": "journey",
"id": "jour_3d7f9a2e5b1c",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"status": "active",
"is_active": true,
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"completions_count": 1,
"award_id": "<string>",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"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"
}
},
"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
}
}
}
},
"milestones": [
{
"object": "milestone",
"id": "mile_5v8b1c6d2fgh",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"action": "join_workspace",
"sort_order": 123,
"multiplier": 123,
"scoped_to_emoji_name": "<string>",
"achievements_count": 1,
"journey_id": "<string>",
"created_by_id": "<string>",
"integrations": {
"slack": {
"channel_ids": [
"<string>"
]
}
},
"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
}
}
}
}
}
]
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "<string>",
"param": "<string>",
"request_id": "req_9f2b8c1d4e5a6b7c8d9e0f1a2b3c4d5e"
}Journeys
Retrieve a journey
Returns one journey by its id.
Retrieve a journey
curl --request GET \
--url https://api.tightknit.ai/v1/journeys/{journey_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/journeys/{journey_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/journeys/{journey_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/journeys/{journey_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/journeys/{journey_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/journeys/{journey_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/journeys/{journey_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": "journey",
"id": "jour_3d7f9a2e5b1c",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"status": "active",
"is_active": true,
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"completions_count": 1,
"award_id": "<string>",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"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"
}
},
"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
}
}
}
},
"milestones": [
{
"object": "milestone",
"id": "mile_5v8b1c6d2fgh",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"label": "<string>",
"action": "join_workspace",
"sort_order": 123,
"multiplier": 123,
"scoped_to_emoji_name": "<string>",
"achievements_count": 1,
"journey_id": "<string>",
"created_by_id": "<string>",
"integrations": {
"slack": {
"channel_ids": [
"<string>"
]
}
},
"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
}
}
}
}
}
]
}{
"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 journey's id.
Pattern:
^jour_[a-zA-Z0-9]{12}$Query Parameters
Repeatable. Returns the named relation inline. One of: award, created_by, updated_by, milestones.
Available options:
award, created_by, updated_by, milestones Response
Success
Always journey.
Available options:
journey Unique identifier for the object.
Example:
"jour_3d7f9a2e5b1c"
When the object was created.
When the object was last changed.
The journey's name, as members see it.
Where the journey is in its run. One of:
scheduled: before its start date.active: running.ended: its end date has passed, even though it is then switched off automatically. A journey with no end date never ends.inactive: switched off (is_activefalse) before it ended.
Available options:
inactive, scheduled, active, ended Example:
"active"
Whether the journey is switched on, so progress counts toward it.
When the journey starts counting progress.
When the journey stops counting progress. Null for a journey that never ends.
How many members have completed every milestone of the journey.
Required range:
x >= 0The id of the award given for completing the journey. Null when none is.
The id of the profile that created the journey. Null when no member is recorded as its creator.
The id of the profile that last changed the journey. Null until it is first changed, or when no member is recorded.
The completion award. Present only when award is expanded.
Show child attributes
Show child attributes
The profile that created the journey. Present only when created_by is expanded.
Show child attributes
Show child attributes
The profile that last changed the journey. Present only when updated_by is expanded.
Show child attributes
Show child attributes
The journey's milestones. Present only when milestones is expanded.
Show child attributes
Show child attributes
Was this page helpful?