Skip to main content
POST
/
api
/
v1
/
task
/
checklists
/
{id}
/
start
Start a new checklist submission
curl --request POST \
  --url https://api.xenia.team/api/v1/task/checklists/{id}/start \
  --header 'workspace-id: <workspace-id>' \
  --header 'x-client-key: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "submissionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "checklist": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "ChecklistItems": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "type": "header",
        "unit": "<string>",
        "order": 123,
        "options": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "label": "<string>",
            "value": "<string>",
            "type": "<string>",
            "color": "<string>",
            "score": 123,
            "flag": true,
            "order": 123
          }
        ],
        "isImageOrNoteRequired": true,
        "required": true
      }
    ]
  }
}

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Headers

workspace-id
string<uuid>
required

Workspace ID

Path Parameters

id
string<uuid>
required

Checklist template ID

Response

200 - application/json

Checklist submission instance created

submissionId
string<uuid>
checklist
object
I