Fetch journey state

Check the status and progress of a journey. The fetch journey state guide explains more.

POST /journey/state/fetch

Fetch journey state

cURL

curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}
'

import requests

url = "https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch"

payload = { "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({instanceId: 'PiIuACmx8Q8R7qPnAkLAqBAT'})
};

fetch('https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'instanceId' => 'PiIuACmx8Q8R7qPnAkLAqBAT'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch"

	payload := strings.NewReader("{\n  \"instanceId\": \"PiIuACmx8Q8R7qPnAkLAqBAT\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instanceId\": \"PiIuACmx8Q8R7qPnAkLAqBAT\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instanceId\": \"PiIuACmx8Q8R7qPnAkLAqBAT\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "metaData": {
    "createdTime": "2024-02-15T22:16:33.213Z",
    "completedTime": "2024-02-15T22:16:33.213Z"
  },
  "status": "InProgress",
  "data": {},
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

instanceId · string · required

Unique identifier for the journey instance.

Example:

"PiIuACmx8Q8R7qPnAkLAqBAT"

Response

200 - application/json

Journey state retrieved successfully.

metaData · object

Timestamps related to the journey instance.

Show child attributes

status · string

Current status of the journey (e.g., InProgress, Completed).

Example:

"InProgress"

data · object

Additional data related to the journey instance.

instanceId · string

Unique identifier for the journey instance.

Example:

"PiIuACmx8Q8R7qPnAkLAqBAT"