v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Scheduling Task

List scheduling tasks

Searches scheduling tasks with status, flag, urgent, queue, tag, delegation, assignee, job, and application filters.

get/v1/tasks

Query parameters

cursorstring

Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters.

limitinteger

Page size. Must be between 1 and 100; defaults to 25.

idsstring[] nullable

Comma-separated list of IDs; maximum 100 values.

[
  "tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789"
]

assignee_idsstring[] nullable

Matches tasks assigned to any listed employee; combines with other filters using AND.

[
  "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
]

statusesstring[] nullable

Matches tasks with any listed status; combines with other filters using AND.

is_urgentboolean

Matches the task urgency flag; combines with other filters using AND.

queue_idsstring[] nullable

Matches tasks in any listed queue; combines with other filters using AND.

[
  "que_a1b2c3d4e5f64789a1b2c3d4e5f64789"
]

flaggedboolean

When true, returns tasks with at least one flag; when false, returns tasks with no flags. Combines with other filters using AND.

tagsstring[] nullable

Matches tasks carrying any listed tag; combines with other filters using AND.

delegate_statusesstring[] nullable

Matches tasks with any listed delegation status; combines with other filters using AND.

job_idsstring[] nullable

Matches tasks for applications on any listed job; combines with other filters using AND.

[
  "job_a1b2c3d4e5f64789a1b2c3d4e5f64789"
]

application_idsstring[] nullable

Matches tasks for any listed application; combines with other filters using AND.

[
  "app_a1b2c3d4e5f64789a1b2c3d4e5f64789"
]

created_at_gtestring date-time

Filters records created at or after this timestamp.

created_at_ltestring date-time

Filters records created at or before this timestamp.

updated_at_gtestring date-time

Filters records updated at or after this timestamp.

updated_at_ltestring date-time

Filters records updated at or before this timestamp.

Response

Success

Example response

{
  "data": [
    {
      "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"
          }
        }
      ]
    }
  ]
}