Retrieve tasks - GBG Documentation

POST

journey

task

list

Retrieve tasks

curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/task/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}
'

{
  "status": "InProgress",
  "instanceId": "<string>",
  "tasks": [
    {
      "taskId": "TkoviRO58Q8R7qPnAkLAqBAT",
      "variantId": "age_verification_all_ssn_dob_required"
    }
  ]
}

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

Tasks retrieved successfully.

status

string

Current status of the journey.

Example:

"InProgress"

instanceId

string

Unique identifier for the instance.

tasks

object[]

Show child attributes

Retrieve tasks with their schemaFetch 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.

⌘I

Retrieve tasks

curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/task/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT"
}
'

{
  "status": "InProgress",
  "instanceId": "<string>",
  "tasks": [
    {
      "taskId": "TkoviRO58Q8R7qPnAkLAqBAT",
      "variantId": "age_verification_all_ssn_dob_required"
    }
  ]
}