GBgbgplc

Fetch journey state

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

post/journey/state/fetch

Request

  • Base URL
    https://eu.platform.go.gbgplc.com/captain/api
  • Auth
    HTTP bearer

Request body

instanceIdstring required

Unique identifier for the journey instance.

Example request

{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}

Response

Journey state retrieved successfully.

statusstring

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

dataobject

Additional data related to the journey instance.

instanceIdstring

Unique identifier for the journey instance.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.