List journey traveller actions

List traveller actions

List all actions for traveller

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

Authorization

tokenAuth

Query parameters

Response

200401

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

Request

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

Response

[
  {
    "short_id": "text",
    "action": "text",
    "description": "text",
    "data": "text",
    "is_automatic": false,
    "parent_action": "text",
    "result": {
      "short_id": "text",
      "date_started": "2024-07-27T06:31:30.353Z",
      "date_updated": "2024-07-27T06:31:30.353Z",
      "date_succeeded": "2024-07-27T06:31:30.353Z",
      "date_failed": "2024-07-27T06:31:30.353Z",
      "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-07-27T06:31:30.353Z",
          "date_updated": "2024-07-27T06:31:30.353Z",
          "date_succeeded": "2024-07-27T06:31:30.353Z",
          "date_failed": "2024-07-27T06:31:30.353Z",
          "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/?traveller_journey=LQK8bydY",
)
print(response.json())         

JavaScript

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

Response samples

200

[
   {
      "shortId":"nKmRwXz8",
      "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":"nyvPjAKZ",
      "assignees":[
         
      ],
      "action":"send_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":{
                  "companyTravellerPhone":{
                     "type":"phone",
                     "field":"phone",
                     "label":"Traveller phone",
                     "source":"company_traveller"
                  }
               }
            }
         ]
      },
      "savedValues":null,
      "isAutomatic":true,
      "description":"Send follow up SMS",
      "dependants":[
         
      ],
      "status":"next_up",
      "parentAction":"nKmRwXz8",
      "result":null,
      "isHalted":false
   }
]