Retrieve the journey
curl --request GET \
--url https://api.custral.com/v1/journey \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.custral.com/v1/journey"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.custral.com/v1/journey', 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.custral.com/v1/journey",
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.custral.com/v1/journey"
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.custral.com/v1/journey")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/journey")
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{
"data": {
"name": "Customer journey",
"status": "draft",
"phases": [
{
"id": "<string>",
"name": "Sales",
"color": "<string>",
"kind": "object",
"source": "own_object",
"objectId": "<string>",
"stagePropertyId": "<string>",
"linkPropertyId": "<string>",
"stages": [
{
"id": "<string>",
"optionId": "<string>",
"name": "Proposal",
"targetDays": 123,
"isExit": true,
"meetings": [
{
"eventTypeId": "<string>",
"playbookId": "<string>",
"label": "Pricing review",
"expected": 123,
"required": true
}
],
"tasks": [
{
"title": "Meet the economic buyer",
"dueDays": 123,
"autoComplete": "manual",
"autoCompleteConfig": {
"propertyId": "<string>",
"minScore": 123
},
"customerVisible": true,
"requiredToExit": true
}
]
}
]
}
],
"id": "jrny_3Ab9xK2mQ7",
"anchorObjectId": "<string>",
"templateKey": "<string>"
},
"reqId": "req_2a1f9c8e7b6d5"
}Customer journeys
Retrieve the journey
The workspace’s customer journey: its phases, their stages, the meetings expected in each stage and the focus tasks created on entering one. A workspace that never saved a journey gets a draft built from its objects, with id: null. Requires scope: objects:read.
GET
/
v1
/
journey
Retrieve the journey
curl --request GET \
--url https://api.custral.com/v1/journey \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.custral.com/v1/journey"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.custral.com/v1/journey', 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.custral.com/v1/journey",
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.custral.com/v1/journey"
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.custral.com/v1/journey")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/journey")
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{
"data": {
"name": "Customer journey",
"status": "draft",
"phases": [
{
"id": "<string>",
"name": "Sales",
"color": "<string>",
"kind": "object",
"source": "own_object",
"objectId": "<string>",
"stagePropertyId": "<string>",
"linkPropertyId": "<string>",
"stages": [
{
"id": "<string>",
"optionId": "<string>",
"name": "Proposal",
"targetDays": 123,
"isExit": true,
"meetings": [
{
"eventTypeId": "<string>",
"playbookId": "<string>",
"label": "Pricing review",
"expected": 123,
"required": true
}
],
"tasks": [
{
"title": "Meet the economic buyer",
"dueDays": 123,
"autoComplete": "manual",
"autoCompleteConfig": {
"propertyId": "<string>",
"minScore": 123
},
"customerVisible": true,
"requiredToExit": true
}
]
}
]
}
],
"id": "jrny_3Ab9xK2mQ7",
"anchorObjectId": "<string>",
"templateKey": "<string>"
},
"reqId": "req_2a1f9c8e7b6d5"
}Authorizations
A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.
Was this page helpful?