Skip to main content
POST
/
journey
/
task
/
list
/
schema
Retrieve tasks with their schema
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/task/list/schema \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}
'
{
  "status": "InProgress",
  "instanceId": "<string>",
  "tasks": [
    {
      "taskId": "<string>",
      "schema": {
        "type": "<unknown>",
        "description": "<unknown>",
        "example": "<unknown>"
      },
      "variantId": "<string>"
    }
  ],
  "schemas": {
    "dynamicObject": {}
  }
}

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

201 - application/json

Successfully retrieved tasks and schemas.

​
status
enum<string>
default:InProgress
required

Current status of the journey instance.

Available options:
Completed,
InProgress,
Failed,
Paused
​
instanceId
string
required

Unique identifier for the active journey instance.

​
tasks
object[]
required
​
schemas
object
required

List of schemas for tasks.