Retrieve journey traveller action

Retrieves a single action from a journey travellers workflow

Retrieve traveller action

Retrieve a traveller action

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

Authorization

tokenAuth

Path parameters

id*string

Response

200401404

Body

application/json

short_idnullable string

action*string

descriptionnullable string

valuesnullable object

data*string

is_automaticboolean

parent_action*string

saved_valuesnullable object

result*ActionResult (object)

status*string

assigneesarray of CompanyUser (object)

group_actions*array of TravellerGroupAction (object)

action_variables*string

has_journey_started*string

is_configured*string

is_journey_paused*string

scheduled_date*string

Response

200

{
  "short_id": "text",
  "action": "text",
  "description": "text",
  "data": "text",
  "is_automatic": false,
  "parent_action": "text",
  "result": {
    "short_id": "text",
    "date_started": "2024-11-21T06:23:50.425Z",
    "date_updated": "2024-11-21T06:23:50.425Z",
    "date_succeeded": "2024-11-21T06:23:50.425Z",
    "date_failed": "2024-11-21T06:23:50.425Z",
    "status": "started",
    "message": "text"
  },
  "status": "text",
  "assignees": [
    {
      "id": "text",
      "short_id": "text",
      "name": "text",
      "email": "[e-mail]",
      "phone": "text",
      "is_active": true,
      "role": {},
      "picture": "https://example.com",
      "send_invite": false,
      "has_set_password": false,
      "is_me": "text",
      "status": "text"
    }
  ],
  "group_actions": [
    {
      "short_id": "text",
      "action": "text",
      "is_complete": false,
      "is_disabled": false,
      "data": "text",
      "result": {
        "short_id": "text",
        "date_started": "2024-11-21T06:23:50.425Z",
        "date_updated": "2024-11-21T06:23:50.425Z",
        "date_succeeded": "2024-11-21T06:23:50.425Z",
        "date_failed": "2024-11-21T06:23:50.425Z",
        "status": "started",
        "message": "text"
      },
      "action_values": "text"
    }
  ],
  "action_variables": "text",
  "has_journey_started": "text",
  "is_configured": "text",
  "is_journey_paused": "text",
  "scheduled_date": "text"
}

Request samples

Python

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

JavaScript

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

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":"[e-mail]",
      "name":null,
      "phone":null
   },
   "scheduledDate":null
}