Skip to main content
POST
/
journey
/
task
/
schema
Retrieve task schema
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/task/schema \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "taskId": "TkoviRO58Q8R7qPnAkLAqBAT"
}
'
{
  "$schema": "<string>",
  "type": "<string>",
  "properties": {},
  "required": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
taskId
string
required

Unique identifier for the task assigned to the customer.

Example:

"TkoviRO58Q8R7qPnAkLAqBAT"

Response

201 - application/json

Schema retrieved successfully.

​
$schema
string
required

The JSON Schema version of the schema.

​
type
string
required

The type of the schema.

​
properties
object
required

An object containing the properties of the schema.

​
required
string[]
required

An array of the required properties of the schema.