GBgbgplc
Customer APIs
Flow Dispatch Service

Get State Data

Changed on

Get State Data

post/journey/state/fetch

Request

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

Request body

instanceIdstring required

Journey Instance Id, a unique identifier for a started journey instance.

filterKeysstring[]

Response

Success

instanceIdstring required

Journey Instance Id, a unique identifier for a started journey instance.

status'Completed' | 'InProgress' | 'Failed' | 'Paused' required
dataobject

Changes

  • 26d99191e88dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      the response property became required for the status

  • 2a328b0cd82dRevision changes
    • breaking

      the response property became optional for the status