Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-267013.8 KB

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

Request body

instanceIdstring required

Unique identifier for the journey instance.

Example request

{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}

Response

Successfully retrieved tasks and schemas.

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

Current status of the journey instance.

instanceIdstring required

Unique identifier for the active journey instance.

schemasobject 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.

Example response

{
  "tasks": [
    {
      "taskId": "Tkr7OENkIqYR8Y2CnrIW3TX-",
      "variantId": "US_AgeVerification_Source1IncludingDOB"
    }
  ]
}