Skip to main content
POST
/
journey
/
state
/
fetch
Fetch journey state
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/state/fetch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "Pq_hhIX6-sHUy9FLSDzPLu"
}
'
{
  "instanceId": "P7U7Licy40cLZiENe8MrsL",
  "status": "InProgress",
  "context": {
    "process": {
      "journey": {
        "name": "Journey Name",
        "startedAt": "2026-03-16T23:56:04.097Z",
        "id": "9dcd95e06495ec32c9ad149283a935548e4a380461b9ee6981af0fef5c70c8c3",
        "version": "5f7yigc4"
      },
      "instance": {
        "id": "P7U7Licy40cLZiENe8MrsL",
        "instanceId": "P7U7Licy40cLZiENe8MrsL"
      },
      "steps": []
    },
    "subject": {},
    "result": {
      "status": "pending",
      "advice": {}
    }
  }
}

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:

"Pq_hhIX6-sHUy9FLSDzPLu"

Response

200 - application/json

Journey state retrieved successfully.

instanceId
string

Unique identifier for the journey instance.

status
string

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

context
object

Full journey context including subject data, result, and process information.