Retrieve tasks with their schema

Fetch all currently active tasks along with their corresponding JSON schema. This allows you to see the expected input fields for each task in a single API call.

POST /journey/task/list/schema

Retrieve tasks with their schema

cURL

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"
}
'

201

{
  "status": "InProgress",
  "instanceId": "<string>",
  "tasks": [
    {
      "taskId": "Tkr7OENkIqYR8Y2CnrIW3TX-",
      "variantId": "US_AgeVerification_Source1IncludingDOB",
      "schema": {}
    }
  ],
  "schemas": {}
}

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

List of active tasks for the journey instance.

Show child attributes

schemas · object · required

A map of schema identifiers to their JSON Schema (draft-07) definitions. Each key corresponds to the reference value in a task's schema object.

Show child attributes