Fetching the journey state allows you to track the progress of a journey instance. It helps you determine whether the journey is still in progress, has completed, or requires further input from the customer.

​
When to fetch the journey state

You should check the journey:
  • After starting a journey – to confirm it was created successfully
  • After submitting task data – to see if the journey progressed or completed
  • To monitor progress – during multi-step journeys with multiple tasks
  • Before triggering next steps – some workflows depend on the journey being completed
  • For troubleshooting – to identify if the journey has stalled

​
What you need before fetching

Make sure you have:

​
API request to fetch state

Send a POST request to the /journey/state/fetch endpoint. Your request should follow this format:
CURL
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/state/fetch \
  --header 'Authorization: Bearer your_access_token' \
  --header 'Content-Type: application/json' \
  --data '{
    "instanceId": "your-instance-id"
  }'
Replace "your-instance-id" with the actual journey instance ID returned when the journey was started.” ”
You receive a response in this format:
JSON
{
  "metaData": {
    "createdTime": "2024-02-15T22:16:33.213Z",
    "completedTime": ""
  },
  "status": "InProgress",
  "data": {},
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}
Refer to the Fetch journey state API reference for details on the request and response definitions.

​
What happens next?

Depending on the state:
StateWhat it means
IN_PROGRESSThe journey is still active. Retrieve remaining tasks.
COMPLETEDThe journey is done. No further action is needed.
FAILEDThe journey encountered an error. Review previous steps or retry.

​
Best practices

  • Periodically check the state for long-running journeys.
  • Always handle FAILED states gracefully and retry if appropriate.
  • Use the COMPLETED state to trigger downstream business logic.

​
Next steps

  • If the journey is complete, your integration is done.
  • If you encountered an error, refer to the Handle errors guide for troubleshooting tips.
  • Check out best practices for executing customer journeys to help with your integration.
  • Use Investigate, a feature in GBG GO to review submitted customer information collected during journey execution. For more information, refer to Investigate overview.