POST
/
journey
/
state
/
fetch
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"
}'
{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT",
  "status": "InProgress",
  "metaData": {
    "createdTime": "2024-02-15T22:16:33.213Z",
    "completedTime": ""
  }
}

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.
instanceId
string

Unique identifier for the journey instance.

Example:

"PiIuACmx8Q8R7qPnAkLAqBAT"

status
string

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

Example:

"InProgress"

metaData
object

Timestamps related to the journey instance.