Retrieve traveller journey

Retrieve traveller journey

Retrieve a traveller journey

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

Authorization

tokenAuth

Path parameters

traveller_id*string

Response

200401404

Body

application/json

id*string

short_idnullable string

journey*all of

emailnullable string (email)

namestring

phonenullable string

supervisornullable string

date_startnullable string (date)

actions*array of TravellerActionList (object)

progress*number (double)

status*string

picturenullable string (uri)

date_created*string (date-time)

date_started*nullable string (date-time)

source*string

source_description*string

journey_started*nullable string (date)

missing_variables*string

date_completed*string (date-time)

is_pausedboolean

Response

200

{
  "id": "text",
  "short_id": "text",
  "journey": {
    "short_id": "text",
    "title": "text",
    "description": "text"
  },
  "email": "[e-mail]",
  "name": "text",
  "phone": "text",
  "supervisor": "text",
  "date_start": "2024-11-21",
  "actions": [
    {
      "short_id": "text",
      "action": "text",
      "is_automatic": false,
      "description": "text",
      "status": "text",
      "parent_action": "text",
      "updated_by": "text",
      "result": {
        "short_id": "text",
        "date_started": "2024-11-21T06:58:55.689Z",
        "date_updated": "2024-11-21T06:58:55.689Z",
        "date_succeeded": "2024-11-21T06:58:55.689Z",
        "date_failed": "2024-11-21T06:58:55.689Z",
        "status": "started",
        "message": "text"
      },
      "is_halted": false,
      "data": "text",
      "scheduled_date": "text"
    }
  ],
  "progress": 0,
  "status": "text",
  "picture": "https://example.com",
  "date_created": "2024-11-21T06:58:55.689Z",
  "date_started": "2024-11-21T06:58:55.689Z",
  "source": "text",
  "source_description": "text",
  "journey_started": "2024-11-21",
  "missing_variables": "text",
  "date_completed": "2024-11-21T06:58:55.689Z",
  "is_paused": false
}

Request samples

Python

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

JavaScript

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

Response samples

200

{
   "id":"6mK7ZPGZ",
   "shortId":"6mK7ZPGZ",
   "journey":{
      "shortId":"8oz3gXzp",
      "title":"A path to Mordor",
      "description":null
   },
   "email":"[e-mail]",
   "name":"Samwise Gamgee",
   "phone":null,
   "actions":[
      {
         "shortId":"8GXqV5KY",
         "assignees":[
            
         ],
         "action":"journey_start",
         "values":null,
         "savedValues":null,
         "isAutomatic":false,
         "description":null,
         "dependants":[
            
         ],
         "status":"waiting_to_be_started",
         "parentAction":null,
         "result":null,
         "isHalted":false
      },
      {
         "shortId":"OzYeb6z5",
         "assignees":[
            
         ],
         "action":"send_sms",
         "values":{
            "message":{
               "value":"Dear Samwise, this is an automatic text reminder about your trip to Mordor.",
               "variables":{
                  
               }
            },
            "recipients":[
               {
                  "value":"{{ company_traveller_phone }}",
                  "variables":{
                     "company_traveller_phone":{
                        "type":"phone",
                        "field":"phone",
                        "label":"Traveller phone",
                        "source":"company_traveller"
                     }
                  }
               }
            ]
         },
         "savedValues":null,
         "isAutomatic":true,
         "description":"Send follow up SMS",
         "dependants":[
            
         ],
         "status":"next_up",
         "parentAction":"8GXqV5KY",
         "result":null,
         "isHalted":false
      }
   ],
   "progress":0.0,
   "status":"not_started",
   "picture":null,
   "dateCreated":"2023-11-15T10:21:27.409393Z",
   "dateStarted":null,
   "source":"Manually added",
   "sourceDescription":null,
   "journeyStarted":null,
   "dateCompleted":null,
   "isPaused":false,
   "journeyAttributes":[
      
   ],
   "companyTravellerAttributes":[
      
   ],
   "companyTravellerShortId":"7VyEbEGr",
   "availableValues":{
      "traveller_journey_name":"Samwise Gamgee",
      "traveller_journey_first_name":"Samwise",
      "traveller_journey_last_name":"Gamgee",
      "traveller_email":"[e-mail]",
      "traveller_journey_phone":"",
      "company_traveller_name":"Samwise Gamgee",
      "company_traveller_first_name":"Samwise",
      "company_traveller_last_name":"Gamgee",
      "company_traveller_phone":"",
      "journey_title":"A path to Mordor",
      "company_name":"50skills"
   }
}