Journeys
  • Introduction
  • Getting access
  • Authentication
  • Terminology
  • API reference
    • Authorization
      • Authorize
    • Company
      • Retrieve company
      • Update company
    • Company lists
      • Retrieve company list
      • List company lists
      • Create company list
      • Update company list
      • Delete company list
    • Journeys
      • List journeys
      • Retrieve journey
      • Delete journey
      • Edit journey
    • Journey actions
      • List journey actions
      • Retrieve journey action
      • Delete journey action
    • Traveller journeys
      • List traveller journeys
      • Retrieve traveller journey
      • Retrieve actions
      • Start traveller journey
      • Create traveller journey
      • Delete traveller journey
    • Traveller journey actions
      • List journey traveller actions
      • Retrieve journey traveller action
    • Users
      • Invite
      • List users
      • Create user
      • Retrieve user
      • Delete user
      • Update user
  • Specification
Powered by GitBook
On this page
  1. API reference
  2. Journeys

Retrieve journey

PreviousList journeysNextDelete journey

Last updated 1 year ago

Request samples

import requests
response = requests.get(
    "https://journeys-api.50skills.app/v1/journeys/ekbCvmCd/",
)
print(response.json())   
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

{
   "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"
      }
   ]
}

Retrieve journey

get

Retrieve a journey

Authorizations
Path parameters
short_idstringRequired
Responses
200Success
application/json
401
Unauthorized
404
Not found
{
  "shortId": "ekbCvmCd",
  "title": "Rivendell",
  "description": "A journey to Rivendell",
  "isActive": true,
  "isTemplate": false,
  "nrActions": 2
}