Retrieve journey

Retrieve journey

get

Retrieve a journey

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

short_idstringRequired

Responses

200Success

application/json

short_idstringRead-onlyRequired

titlestringRequired

descriptionstring · nullableOptional

is_activebooleanOptionalDefault: false

is_templatebooleanOptionalDefault: false

has_published_journeybooleanRead-onlyRequired

has_unpublished_changesbooleanOptional

date_publishedstring · date-timeRead-onlyRequired

is_configuredstringRead-onlyRequired

num_actionsintegerRead-onlyRequired

401

Unauthorized

404

Not found

get

v1/journeys/{short_id}/

Python

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

{
  "shortId": "ekbCvmCd",
  "title": "Rivendell",
  "description": "A journey to Rivendell",
  "isActive": true,
  "isTemplate": false,
  "nrActions": 2
}

Request samples

Python

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

JavaScript

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