Retrieve journey

Retrieve journey

Retrieve a journey

GEThttps://journeys-api.50skills.app/v1/journeys/{short_id}/

Authorization

tokenAuth

Path parameters

short_id*string

Response

200401404

Body

application/json

short_id*string

title*string

descriptionnullable string

is_activeboolean

is_templateboolean

has_published_journey*boolean

has_unpublished_changesboolean

date_published*string (date-time)

is_configured*string

num_actions*integer

Response

200

{
  "short_id": "text",
  "title": "text",
  "description": "text",
  "is_active": false,
  "is_template": false,
  "has_published_journey": false,
  "has_unpublished_changes": false,
  "date_published": "2024-12-21T13:00:31.665Z",
  "is_configured": "text",
  "num_actions": 0
}

Request samples

Python

import requests
response = requests.get(
    "https://journeys-api.50skills.app/v1/journeys/ekbCvmCd/",
)
print(response.json())   

JavaScript

fetch("https://journeys-api.50skills.app/v1/journeys/ekbCvmCd/")
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));                                  

Response samples

200

{
   "shortId":"rBKvXUOq",
   "title":"New Employee Onboarding - Office, Reykjavik",
   "description":"Onboarding for new hires that are joining our offices in Reykjavik",
   "isActive":false,
   "isTemplate":false,
   "hasPublishedJourney":false,
   "hasUnpublishedChanges":true,
   "datePublished":null,
   "isConfigured":true,
   "attributes":[
      {
         "shortId":"7VrENKGr",
         "templateTitle":"First workday",
         "templateShortId":"rbKVXyOq",
         "attributeType":"date",
         "isActive":true,
         "isRequired":false,
         "options":null,
         "order":0
      },
      {
         "shortId":"rbMVn0KO",
         "templateTitle":"Supervisor",
         "templateShortId":"7VyE9yrR",
         "attributeType":"user",
         "isActive":true,
         "isRequired":false,
         "options":null,
         "order":1
      }
   ],
   "attributeVariables":[
      {
         "label":"First workday",
         "source":"journey_attribute__4VyXNJGr",
         "field":"value",
         "type":"date"
      },
      {
         "label":"Supervisor name",
         "source":"journey_attribute__rbMVn0YO",
         "field":"name",
         "type":"text"
      }
   ]
}