Skip to main content
GET
/
v2
/
tasks
/
{task_id}
{
  "id": "<string>",
  "title": "<string>",
  "status": "todo",
  "source": {
    "type": "requirement",
    "context": {
      "scope": "employee",
      "employee_id": "<string>"
    },
    "requirement_id": "<string>",
    "definition": "<string>",
    "summary": "<string>",
    "resources": [
      {}
    ],
    "period_start_date": "2023-12-25",
    "period_end_date": "2023-12-25",
    "due_date": "2023-12-25",
    "region": {
      "id": "<string>",
      "name": "<string>"
    },
    "fee": {
      "type": "fixed",
      "amount": "<string>"
    },
    "eta": {
      "estimation": {
        "min": 123,
        "max": 123,
        "unit": "hour"
      },
      "earliest_date": "2023-11-07T05:31:56Z",
      "latest_date": "2023-11-07T05:31:56Z"
    },
    "tags": [
      "certificate-of-good-standing"
    ],
    "default_resolution_name": "manual",
    "resolutions": {
      "hosted": {
        "type": "hosted",
        "description": "<string>",
        "method": "<string>",
        "url": "<string>",
        "content_type": "<string>",
        "fields": [
          {
            "name": "<string>",
            "description": "<string>",
            "required": true,
            "type": "<string>"
          }
        ]
      },
      "manual": {
        "type": "manual",
        "steps": [
          {
            "id": "<string>",
            "title": "<string>",
            "description": "<string>",
            "paths": [
              {
                "type": "<string>",
                "value": "<string>",
                "text": "<string>"
              }
            ],
            "order": 123
          }
        ]
      }
    },
    "criteria_met": [
      {
        "type": "requirement-done",
        "reason": "<string>",
        "task_id": "<string>"
      }
    ],
    "unlocks": [
      {
        "requirement_id": "<string>",
        "title": "<string>",
        "definition": "<string>",
        "summary": "<string>",
        "resources": [
          {}
        ],
        "region": {
          "id": "<string>",
          "name": "<string>"
        },
        "tags": [
          "certificate-of-good-standing"
        ],
        "source": "requirement"
      }
    ],
    "category": "hr",
    "automation_status": "started"
  },
  "priority": "high",
  "is_managed": false
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

task_id
string
required

Response

Successful Response

id
string
required
title
string
required
status
enum<string>
required
Available options:
todo,
deferred,
in-progress,
done
source
object
required
  • PlatformTaskRequirement
  • PlatformTaskQuestion
priority
enum<string> | null
default:medium
Available options:
high,
medium,
low
is_managed
boolean
default:false
I