Retrieve traveller journey

Retrieve traveller journey

get

Retrieve a traveller journey

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

traveller_idstringRequired

Responses

200Success

application/json

idstringRead-onlyRequired

short_idstring · max: 255 · nullableOptional

emailstring · email · nullableOptional

namestringOptional

phonestring · nullableOptional

supervisorstring · nullableOptional

date_startstring · date · nullableOptional

progressnumber · doubleRead-onlyRequired

statusstringRead-onlyRequired

picturestring · uri · nullableOptional

date_createdstring · date-timeRequired

date_startedstring · date-time · nullableRead-onlyRequired

sourcestringRead-onlyRequired

source_descriptionstringRead-onlyRequired

journey_startedstring · date · nullableRead-onlyRequired

missing_variablesstringRead-onlyRequired

date_completedstring · date-timeRead-onlyRequired

is_pausedbooleanOptional

401

Unauthorized

404

Not found

get

v1/traveller-journeys/{short_id}/

Python

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

{
  "id": "9rKdez72",
  "shortId": "9rKdez72",
  "name": "Just Better",
  "phone": null,
  "journey": {
    "shortId": "6mK7AyZV",
    "title": "To the title",
    "description": "None"
  },
  "dateStart": "2023-01-01",
  "progress": 1,
  "status": "completed",
  "supervisor": {
    "email": "[email protected]",
    "isActive": true,
    "name": "Phil Jackson",
    "role": "admin",
    "shortId": "7x89X78y"
  },
  "email": "[email protected]",
  "picture": null,
  "source": "Manually added",
  "source_description": null,
  "date_created": "2023-03-16T12:00:00Z",
  "date_started": "2023-03-17T12:00:00Z",
  "actions": [
    {
      "shortId": "AYGpl0Go",
      "action": "journey_start",
      "description": null,
      "values": null,
      "isAutomatic": false,
      "isComplete": true,
      "parentAction": null,
      "savedValues": null,
      "data": null,
      "result": {
        "short_id": "BKAplOGv",
        "date_started": "2023-03-17T12:00:00Z",
        "date_updated": null,
        "date_succeeded": "2023-03-17T12:01:00Z",
        "date_failed": null,
        "status": "success"
      }
    },
    {
      "short_id": "8oz3MlGp",
      "action": "send_sms",
      "description": "Send sms to traveller",
      "values": {
        "message": {
          "value": "Sms message to traveller"
        },
        "recipients": [
          {
            "value": "[phone]"
          }
        ]
      },
      "isAutomatic": false,
      "isComplete": true,
      "parentAction": "AYGpl0Go",
      "savedValues": {
        "message": "Sms message to traveller",
        "recipients": [
          "[phone]"
        ]
      },
      "data": {
        "message": "Sms message to traveller",
        "recipients": [
          "[phone]"
        ]
      },
      "result": {
        "short_id": "CLAplal0v",
        "date_started": "2023-03-17T12:02:00Z",
        "date_updated": null,
        "date_succeeded": "2023-03-17T12:03:00Z",
        "date_failed": null,
        "status": "success"
      }
    }
  ]
}

Request samples

Python

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

JavaScript

Response samples

200

{
   "id":"6mK7ZPGZ",
   "shortId":"6mK7ZPGZ",
   "journey":{
      "shortId":"8oz3gXzp",
      "title":"A path to Mordor",
      "description":null
   },
   "email":"[email protected]",
   "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":"[email protected]",
      "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"
   }
}