v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Schedule

Get a schedule

Returns a schedule group and the interview events it contains, including their timing and participants. The schedule must belong to the authenticated organization or the request returns not found.

get/v1/schedules/{scheduleId}

Path parameters

scheduleIdstring required

a schedule 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:sch_a1b2c3d4e5f64789a1b2c3d4e5f64789

Response

Success

idstring required

Canonical schedule ID (sch_ followed by 32 lowercase hexadecimal UUID characters).

status'SCHEDULED' | 'PARTIALLY_DECLINED' | 'CANCELED' required

start_atstring date-time required

ISO 8601 timestamp.

end_atstring date-time required

ISO 8601 timestamp.

timezonestring required

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

app_urlstring uri required

Example response

{
  "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"
  }
}