Retrieve journey action

Retrieve journey action

Retrieve a journey action

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

Authorization

tokenAuth

Path parameters

id*string

Response

200401404

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

Response

200

{
  "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/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
}