Sign in

v1

latestOpenAPI 3.1.02026-07-224239180.9 KB
Schedule

List schedules

Returns paginated schedule groups, each with its nested interview events. Record timestamp filters narrow the schedule records and are combined with IDs when supplied. Use the cursor to continue the same filtered result set.

get/v1/schedules

Query parameters

cursorstring

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

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.

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

idsstring[] nullable

Comma-separated list of IDs; maximum 100 values.

Comma-separated list of IDs; maximum 100 values.

[
  "sch_a1b2c3d4e5f64789a1b2c3d4e5f64789"
]
created_at_gtestring date-time

Filters records created at or after this timestamp.

Filters records created at or after this timestamp.

created_at_ltestring date-time

Filters records created at or before this timestamp.

Filters records created at or before this timestamp.

updated_at_gtestring date-time

Filters records updated at or after this timestamp.

Filters records updated at or after this timestamp.

updated_at_ltestring date-time

Filters records updated at or before this timestamp.

Filters records updated at or before this timestamp.

Response

Success

Example response

{
  "data": [
    {
      "id": "sch_a1b2c3d4e5f64789a1b2c3d4e5f64789",
      "application": {
        "id": "app_a1b2c3d4e5f64789a1b2c3d4e5f64789",
        "candidate": {
          "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789"
        },
        "job": {
          "id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789"
        },
        "stage": {
          "id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
        }
      },
      "interviews": [
        {
          "id": "int_a1b2c3d4e5f64789a1b2c3d4e5f64789",
          "schedule_id": "sch_a1b2c3d4e5f64789a1b2c3d4e5f64789",
          "application": {
            "id": "app_a1b2c3d4e5f64789a1b2c3d4e5f64789",
            "candidate": {
              "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789"
            },
            "job": {
              "id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789"
            },
            "stage": {
              "id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
            }
          },
          "interviewers": [
            {
              "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
            }
          ]
        }
      ],
      "task": {
        "id": "tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789"
      }
    }
  ]
}