Sign in

v1

latestOpenAPI 3.1.02026-07-224239180.9 KB
Scheduling Task

Get a scheduling task

Returns one scheduling task with its application, stage, assignee, queue, tags, flags, delegation, notes, and timing metadata. The task must belong to the authenticated organization or the request returns not found.

get/v1/tasks/{taskId}

Path parameters

taskIdstring required

a task ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Example:tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789

Response

Success

idstring required

Canonical task ID (tsk_ followed by 32 lowercase hexadecimal UUID characters).

status'NEEDS_AVAILABILITY' | 'WAITING_FOR_CANDIDATE' | 'READY_TO_SCHEDULE' | 'READY_TO_RESCHEDULE' | 'HOLD' | 'READY_TO_SEND_TO_CANDIDATE' | 'SCHEDULED' | 'COMPLETED' | 'CANCELED' | 'NEEDS_DEBRIEF' required
is_urgentboolean required
queue_idstring nullable required

Canonical task queue ID (que_ followed by 32 lowercase hexadecimal UUID characters).

tagsstring[] required
is_debrief_requiredboolean required
created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

app_urlstring uri required

Example response

{
  "id": "tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "application": {
    "id": "app_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "candidate": {
      "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    },
    "job": {
      "id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    }
  },
  "job_stage": {
    "id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "assignee": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "queue_id": "que_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "notes": [
    {
      "author": {
        "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
      }
    }
  ]
}