Retrieve journey action

Retrieve journey action

get

Retrieve a journey action

Authorizations

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

is_automaticbooleanOptional

dependantsstringRead-onlyRequired

action_variablesstringRead-onlyRequired

is_configuredstringRead-onlyRequired

ancestorsstringRead-onlyRequired

descendantsstringRead-onlyRequired

journeystringRead-onlyRequired

401

Unauthorized

404

Not found

getv1/journey-actions/{id}/

Python

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

{
  "shortId": "1YKMe7K5",
  "action": "send_sms",
  "description": "Send sms to traveller",
  "values": {
    "recipients": [
      {
        "value": "[phone]"
      }
    ],
    "message": {
      "value": "The message sent"
    }
  },
  "isAutomatic": false,
  "assignees": [],
  "parentAction": "qwKJ3z9B",
  "journey": "48GX8GYl",
  "isConfigured": true
}

Request samples

Python

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

JavaScript

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

Response samples

200

{
   "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":[
      
   ],
   "actionVariables":[
      {
         "action":"journey_start",
         "label":null,
         "description":null,
         "shortId":"YGPe0LKw",
         "fields":{
            
         }
      }
   ],
   "isConfigured":true,
   "ancestors":[
      "YGPe0LKw"
   ],
   "descendants":[
      "vzL7jYK3"
   ],
   "isInsideLoop":false,
   "groupActions":[
      
   ],
   "journey":"8oz3gXzp",
   "reminder":null
}