List traveller journeys

List traveller journeys

get

List all traveller journeys

Authorizations

Query parameters

journeystringOptional

Journey id

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Responses

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "9rKdez72",
      "shortId": "9rKdez72",
      "name": "Just Better",
      "phone": null,
      "journey": "6mK7AyZV",
      "dateStart": "2023-01-01",
      "progress": 1,
      "status": "completed",
      "supervisor": {
        "email": "[e-mail]",
        "isActive": true,
        "name": "Phil Jackson",
        "role": "admin",
        "shortId": "7x89X78y"
      },
      "email": "[e-mail]",
      "picture": null,
      "source": "Manually added",
      "source_description": null,
      "actions": [
        {
          "shortId": "AYGpl0Go",
          "action": "journey_start",
          "description": null,
          "values": null,
          "isAutomatic": false,
          "isComplete": true,
          "parentAction": null,
          "savedValues": null,
          "data": null,
          "result": {
            "short_id": "BKAplOGv",
            "date_started": "2023-03-17T12:00:00Z",
            "date_updated": null,
            "date_succeeded": "2023-03-17T12:01:00Z",
            "date_failed": null,
            "status": "success"
          }
        },
        {
          "short_id": "8oz3MlGp",
          "action": "send_sms",
          "description": "Send sms to traveller",
          "values": {
            "message": {
              "value": "Sms message to traveller"
            },
            "recipients": [
              {
                "value": "[phone]"
              }
            ]
          },
          "isAutomatic": false,
          "isComplete": true,
          "parentAction": "AYGpl0Go",
          "savedValues": {
            "message": "Sms message to traveller",
            "recipients": [
              "[phone]"
            ]
          },
          "data": {
            "message": "Sms message to traveller",
            "recipients": [
              "[phone]"
            ]
          },
          "result": {
            "short_id": "CLAplal0v",
            "date_started": "2023-03-17T12:02:00Z",
            "date_updated": null,
            "date_succeeded": "2023-03-17T12:03:00Z",
            "date_failed": null,
            "status": "success"
          }
        }
      ]
    }
  ]
}

Request samples

Python

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

JavaScript

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

Response samples

200

{
   "count":2,
   "next":null,
   "previous":null,
   "results":[
      {
         "id":"eJzQZrym",
         "shortId":"eJzQZrym",
         "journey":"8oz3gXzp",
         "email":"[e-mail]",
         "name":"Frodo Baggins",
         "phone":null,
         "progress":0.0,
         "status":"not_started",
         "picture":null,
         "journeyAttributes":[
            
         ],
         "companyTravellerAttributes":[
            
         ],
         "companyTravellerShortId":"ekzaBlyO"
      },
      {
         "id":"6mK7ZPGZ",
         "shortId":"6mK7ZPGZ",
         "journey":"8oz3gXzp",
         "email":"[e-mail]",
         "name":"Samwise Gamgee",
         "phone":null,
         "progress":0.0,
         "status":"not_started",
         "picture":null,
         "journeyAttributes":[
            
         ],
         "companyTravellerAttributes":[
            
         ],
         "companyTravellerShortId":"7VyEbEGr"
      }
   ]
}