List journey actions

List journey actions

List all actions for journey

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

Authorization

tokenAuth

Query parameters

Response

200401

Body

application/json

short_idnullable string

action*string

descriptionnullable string

valuesnullable object

is_automaticboolean

assigneesarray of CompanyUser (object)

parent_action*ParentAction (object)

dependants*string

action_variables*string

is_configured*string

ancestors*string

descendants*string

group_actions*array of JourneyGroupAction (object)

journey*string

Request

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

Response

[
  {
    "short_id": "text",
    "action": "text",
    "description": "text",
    "is_automatic": false,
    "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"
      }
    ],
    "parent_action": {
      "short_id": "text",
      "action": "text"
    },
    "dependants": "text",
    "action_variables": "text",
    "is_configured": "text",
    "ancestors": "text",
    "descendants": "text",
    "group_actions": [
      {
        "short_id": "text",
        "action": "text",
        "parent_action": "text",
        "is_disabled": false,
        "action_variables": "text"
      }
    ],
    "journey": "text"
  }
]

Request samples

Python

import requests
response = requests.get(
    "https://journeys-api.50skills.app/v1/journey-actions/?journey_id=48GX8GYl",
)
print(response.json())

JavaScript

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

Response samples

200

[
   {
      "shortId":"YGPe0LKw",
      "action":"journey_start",
      "description":null,
      "values":null,
      "isAutomatic":false,
      "assignees":[
         
      ],
      "parentAction":null,
      "dependants":[
         
      ],
      "isConfigured":true
   },
   {
      "shortId":"OynNw8yR",
      "action":"send_email",
      "description":"Send E-mail to Sauron",
      "values":{
         "content":{
            "value":"Dear Sauron,This is an informational post that {{ company_traveller_first_name }} is coming to visit tomorrow afternoon.",
            "variables":{
               "company_traveller_first_name":{
                  "type":"text",
                  "field":"first_name",
                  "label":"Traveller first name",
                  "action":"undefined",
                  "source":"company_traveller"
               }
            }
         },
         "subject":{
            "value":"{{ company_traveller_name }} is coming your way",
            "variables":{
               "company_traveller_name":{
                  "type":"text",
                  "field":"name",
                  "label":"Traveller full name",
                  "action":"undefined",
                  "source":"company_traveller"
               }
            }
         },
         "recipients":[
            {
               "value":"{{ traveller_email }}",
               "variables":{
                  "traveller_email":{
                     "type":"email",
                     "field":"email",
                     "label":"Traveller email",
                     "action":"undefined",
                     "source":"traveller"
                  }
               }
            }
         ],
         "attachments":[
            
         ]
      },
      "isAutomatic":true,
      "assignees":[
         
      ],
      "parentAction":{
         "shortId":"YGPe0LKw",
         "action":"journey_start",
         "values":null
      },
      "dependants":[
         
      ],
      "isConfigured":true
   },
   {
      "shortId":"vzL7jYK3",
      "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",
                     "action":"undefined",
                     "source":"company_traveller"
                  }
               }
            }
         ]
      },
      "isAutomatic":true,
      "assignees":[
         
      ],
      "parentAction":{
         "shortId":"OynNw8yR",
         "action":"send_email",
         "values":{
            "content":{
               "value":"Dear Sauron,This is an informational post that {{ company_traveller_first_name }} is coming to visit tomorrow afternoon.",
               "variables":{
                  "company_traveller_first_name":{
                     "type":"text",
                     "field":"first_name",
                     "label":"Traveller first name",
                     "action":"undefined",
                     "source":"company_traveller"
                  }
               }
            },
            "subject":{
               "value":"{{ company_traveller_name }} is coming your way",
               "variables":{
                  "company_traveller_name":{
                     "type":"text",
                     "field":"name",
                     "label":"Traveller full name",
                     "action":"undefined",
                     "source":"company_traveller"
                  }
               }
            },
            "recipients":[
               {
                  "value":"{{ traveller_email }}",
                  "variables":{
                     "traveller_email":{
                        "type":"email",
                        "field":"email",
                        "label":"Traveller email",
                        "action":"undefined",
                        "source":"traveller"
                     }
                  }
               }
            ],
            "attachments":[
               
            ]
         }
      },
      "dependants":[
         
      ],
      "isConfigured":true
   }
]