Retrieve journey traveller action

Retrieves a single action from a journey travellers workflow

Retrieve traveller action

get

Retrieve a traveller action

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

short_idstring · max: 255 · nullableOptional

actionstring · max: 200Required

descriptionstring · nullableOptional

datastringRead-onlyRequired

is_automaticbooleanOptional

parent_actionstringRequired

statusstringRead-onlyRequired

action_variablesstringRead-onlyRequired

has_journey_startedstringRead-onlyRequired

is_configuredstringRead-onlyRequired

is_journey_pausedstringRead-onlyRequired

scheduled_datestringRead-onlyRequired

401

Unauthorized

404

Not found

get

v1/traveller-actions/{id}/

Python

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

{
  "shortId": "8oz3MlGp",
  "action": "send_sms",
  "description": "Send sms to traveller",
  "values": {
    "message": {
      "value": "Sms message to traveller"
    },
    "recipients": [
      {
        "value": "[phone]"
      }
    ]
  },
  "isAutomatic": false,
  "isComplete": false,
  "parentAction": null,
  "savedValues": null,
  "data": {
    "message": "Sms message to traveller",
    "recipients": [
      "[phone]"
    ]
  },
  "result": null
}

Request samples

Python

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

JavaScript

Response samples

200

{
   "shortId":"nyvPjAKZ",
   "action":"send_sms",
   "description":"Send follow up SMS",
   "values":{
      "message":{
         "value":"Dear Frodo Baggins, 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"
               }
            }
         }
      ]
   },
   "data":{
      "message":"Dear Frodo Baggins, this is an automatic text reminder about your trip to Mordor.",
      "recipients":[
         "[phone]"
      ]
   },
   "isAutomatic":true,
   "parentAction":"nKmRwXz8",
   "savedValues":null,
   "result":null,
   "status":"next_up",
   "ancestors":[
      "nKmRwXz8"
   ],
   "descendants":[
      
   ],
   "assignees":[
      
   ],
   "groupActions":[
      
   ],
   "actionVariables":[
      {
         "action":"journey_start",
         "label":null,
         "description":null,
         "shortId":"nKmRwXz8",
         "fields":{
            
         }
      }
   ],
   "hasJourneyStarted":false,
   "isConfigured":true,
   "travellerJourneyId":"AOyeJ4GX",
   "journeyId":"8oz3gXzp",
   "reminder":null,
   "isJourneyPaused":false,
   "reminderSchedules":[
      
   ],
   "travellerJourney":{
      "id":"AOyeJ4GX",
      "shortId":"AOyeJ4GX",
      "journey":"8oz3gXzp",
      "email":"[email protected]",
      "name":null,
      "phone":null
   },
   "scheduledDate":null
}