Ctrlk
My AccountNewsContact
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Schedules

List Schedules

GET /schedules.json

Retrieve upcoming schedule records and status definitions.

Response

{
  "future": [
    {
      "Schedule": {
        "id": "789",
        "status": "confirmed",
        "title": "Training Flight",
        "departure_airport": "LEMD",
        "landing_airport": "LEMD",
        "start": "2025-03-15 08:00:00",
        "end": "2025-03-15 10:00:00",
        "notes": "Circuit training",
        "aircraft_id": "45",
        "pic_id": "123",
        "sic_id": null,
        "supervisor_id": null,
        "flight_type_id": "1",
        "flight_id": null,
        "pic_status": "accepted",
        "sic_status": "pending",
        "user_status": "accepted",
        "notified": true,
        "borderColor": "#3498db"
      },
      "Pic": {
        "id": "123",
        "email": "john@example.com",
        "user_group_id": "110",
        "UserGroup": { "name": "Pilot" },
        "UserDetail": { "name": "John", "surname": "Doe", "id": "123" }
      },
      "Sic": null,
      "Supervisor": null,
      "Flight": null,
      "Aircraft": {
        "registration": "EC-ABC",
        "photo": "https://...",
        "aircraft_model_id": "10",
        "AircraftModel": {
          "id": "10",
          "icao": "C172",
          "name": "C172",
          "type": "SEP",
          "AircraftManufacturer": { "name": "Cessna" }
        }
      },
      "FlightType": { "name": "Training", "color": "#3498db" },
      "PicTrainingFlight": null,
      "SicTrainingFlight": null
    }
  ],
  "canCreate": true,
  "status": {
    "confirmed": { "color": "#2ecc71", "class": "success", "name": "Confirmed" },
    "pending": { "color": "#f39c12", "class": "warning", "name": "Pending" },
    "cancelled": { "color": "#e74c3c", "class": "danger", "name": "Cancelled" }
  },
  "crewstatus": {
    "accepted": { "color": "#2ecc71", "class": "success", "name": "Accepted" },
    "pending": { "color": "#f39c12", "class": "warning", "name": "Pending" },
    "declined": { "color": "#e74c3c", "class": "danger", "name": "Declined" }
  }
}

View Schedule

GET /schedules/view/{id}.json

Retrieve full details for a single schedule record, including history.

Users with user_group_id > 170 may only view schedules they are involved in (creator, PIC, SIC, supervisor, or owner of the aircraft). Otherwise returns 403 Forbidden.

Path Parameters

Parameter
Type
Description

id

string

Schedule ID

Response

Same structure as a single item in the future array, plus:

Each ScheduleHistory row carries a reason. Alongside the manual reasons (weather, maintenance, pilot, etc.), NOT_FLOWN marks a booking that the system auto-cancelled because it was scheduled but never dispatched or logged past the company's not-flown grace window. Its user_id is the PIC (attribution), so it counts against the PIC in the cancellation analytics.

Dispatch Schedule

GET /schedules/flight/{scheduleId}.json

Create a flight record from a schedule (dispatch function). Converts the schedule entry into an actual flight.

Path Parameters

Parameter
Type
Description

scheduleId

string

Schedule ID to dispatch

Flight Risk Assessment (FRAT)

When the company setting schedule_dispatch_frat is enabled and the authenticated user is a crew member of the schedule (PIC, SIC or Supervisor), a completed FRAT is mandatory. In that case call this endpoint with POST and include the FRAT fields below; the dispatch is rejected (result: false) if they are missing. When the setting is off, or the dispatcher is not crew, the GET form is sufficient.

The FRAT result is stored per flight and per user (one row per crew member).

Field
Type
Description

frat_score

integer

Total weighted risk score

frat_band

string

Risk band: LOW, MEDIUM or HIGH

frat_data

string

JSON map of question id → chosen answer value

A HIGH band may only be dispatched by a Supervisor. Plans: Club, Premium, Unlimited.

FRAT Prefill

GET /schedules/frat_prefill/{scheduleId}.json

Returns objective signals computed from the authenticated user's own flight history, used to pre-answer the data-backed FRAT questions. Scoped to the caller and their company.

Path Parameters

Parameter
Type
Description

scheduleId

string

Schedule ID the assessment is for

Response

Field
Type
Description

hours_90

number

Block hours flown (as PIC or SIC) in the last 90 days

model_hours

number

Block hours on this schedule's aircraft model in the last 12 months

model_known

boolean

Whether the schedule's aircraft has a known model

night_hours

number

Night flight hours in the last 12 months

departure_flown

boolean | null

Whether the user has flown to/from the departure airport before (null if unknown)

landing_flown

boolean | null

Whether the user has flown to/from the destination airport before (null if unknown)

Availability

Get Availability

GET /schedules/get_availability.json

Retrieve pilot availability records within a date range.

Query Parameters

Parameter
Type
Required
Description

start

string

Yes

Start date (YYYY-MM-DD)

end

string

Yes

End date (YYYY-MM-DD)

timeZone

string

Yes

IANA timezone name (e.g. Europe/Madrid)

Response

Availability Types

Type
Description

AVAILABLE

Pilot is available for scheduling

UNAVAILABLE

Pilot is not available

MAYBE

Pilot may be available (conditional)

ALWAYS

Pilot is always available (default)

Add Availability

POST /schedules/add_availability.json

Create a new availability record.

Request Body

Field
Type
Required
Description

start

string

Yes

Start datetime

end

string

Yes

End datetime

type

string

Yes

AVAILABLE, UNAVAILABLE, or MAYBE

Edit Availability

POST /schedules/edit_availability.json

Update an existing availability record.

Request Body

Field
Type
Required
Description

id

string

Yes

Availability record ID

start

string

Yes

Start datetime

end

string

Yes

End datetime

type

string

Yes

AVAILABLE, UNAVAILABLE, or MAYBE

Delete Availability

GET /schedules/delete_availability/{id}.json

Delete a specific availability record.

Delete All Availability

GET /schedules/delete_availability/all.json

Delete all availability records for the authenticated user.

Delete "Always Available"

GET /schedules/delete_availability/always.json

Remove the "always available" default setting.

Calendar Events

GET /events/calendar.json

Retrieve calendar events (schedules, classes, exams) within a date range.

Query Parameters

Parameter
Type
Required
Description

start

string

Yes

Start date

end

string

Yes

End date

timeZone

string

Yes

IANA timezone name

Response

Events Index

GET /events/index.json

Retrieve events for the dashboard view.

Query Parameters

Parameter
Type
Required
Description

start

string

Yes

Start date

end

string

Yes

End date

Event Reason Totals

GET /schedules/reports_event_reasons/{action}/{year}/{month}.json

Aggregate counts of ScheduleHistory.reason for a given action within a month, scoped to the authenticated user's company.

Path Parameters

Parameter
Type
Required
Description

action

string

Yes

History action, e.g. CANCELED, REJECTED, ACCEPTED

year

int

Yes

Year

month

int

Yes

Month (1-12)

Response

Rows with null reason are omitted. totals is always a zero-indexed JSON array. For action = CANCELED, the NOT_FLOWN ("Not flown") reason appears for bookings the system auto-cancelled as no-shows, attributed to the PIC.

Find Slots

POST /schedules/find_slot.json

Finds bookable slots for a date and aircraft. The pic parameter is optional — when omitted (student self-bookings) pilot availability is not checked and only the aircraft, maintenance, CRS expiry and the requesting user's own schedule are considered.

Each result carries an available marker:

  • available: true — the slot is fully free and can be booked directly.

  • available: false — the slot is blocked only by a PENDING booking (a student booking still waiting for a Flight Instructor). The PENDING record may be auto-canceled later, so the slot is still returned: the frontend shows it in yellow and offers to add it to the watchlist. Slots blocked by a confirmed booking, maintenance, an expired CRS or the user's own schedule are not returned at all.

Cancelled records (status = CANCELED, whether cancelled manually or auto-cancelled as NOT_FLOWN) are excluded from the search, so their time frame is offered again for new bookings.

Slots are generated inside the operating-hours windows configured for the aircraft's base on that date (see company operating hours). A day may hold several windows, and slots are generated per window, so no slot ever spans the closed stretch between two of them. When the base keeps no hours on the requested date the response carries closed: true with an empty results array — that is "the field is shut that day", which is a different answer from an open day whose slots are all taken.

Body Parameters

Parameter
Type
Required
Description

date

string

Yes

Day to search (YYYY-MM-DD)

aircraft

int

Yes

Aircraft id

pic

int

No

Pilot id — when omitted, availability is not checked

Response

closed is true when the aircraft's base has no operating hours on the requested date; results is then always empty.

Available Flight Instructor (student self-booking)

POST /schedules/available_fi.json

Returns the Flight Instructor the system would auto-assign as PIC for a student self-booking, or null when none is available (the booking would then be stored with the PENDING status).

Selection rules: the FI must have user_group_id <= 170, pilot = true, active = true; an availability record of type AVAILABLE or ALWAYS (never MAYBE/UNAVAILABLE) covering the full time frame; no conflicting schedule or onsite class; the aircraft within their aircraft attributions (empty list = all aircraft); and the flight type within their flight type attributions (empty list = all flight types). The student's assigned FI (training supervisor) has priority over other available FIs.

Body Parameters

Parameter
Type
Required
Description

start

int

Yes

Slot start (unix timestamp)

end

int

Yes

Slot end (unix timestamp)

aircraft

int

Yes

Aircraft id

flight_type

string

No

Flight type id

Response

fi is null when no instructor is available.

Flight Instructor Availabilities

GET /schedules/fi_availabilities.json?start={unix}&end={unix}

Weekly availability of all Flight Instructors (user_group_id <= 170 and pilot = true) of the company.

Access control: managers (user_group_id <= 150) always; FIs (user_group_id 151–170 with pilot = true) only when the ALLOW FI SCHEDULE MANAGEMENT company setting (schedule_allow_fi_management) is enabled. All other users receive 403 Forbidden.

Response

My Slot Watchlist

GET /schedules/watchlist.json

Lists the authenticated user's future slot watchlist entries. When a booking overlapping a watched slot is canceled or deleted, the watcher is notified (push notification + message) so they can grab the freed slot. Past entries are removed by the night cron.

Response

available is set to true when an overlapping booking was canceled or deleted after the watch was created — the slot is now free and the entry is highlighted in green in the Schedules page widget.

Watch a Slot

POST /schedules/watchlist_add.json

Adds an aircraft + time frame to the authenticated user's watchlist. Only active pilots (pilot = true, active = true) can watch slots; other users receive 403 Forbidden. Overlapping entries for the same aircraft are merged.

If no active booking overlaps the requested time frame, the slot is already free: no record is created and the response carries slotAvailable: true so the client can tell the user to book right away.

Body Parameters

Parameter
Type
Required
Description

aircraft_id

int

Yes

Aircraft id (must be active and belong to the company)

start

int

Yes

Watch start (unix timestamp)

end

int

Yes

Watch end (unix timestamp, must be in the future)

Response

Remove a Watchlist Entry

POST /schedules/watchlist_delete/{id}.json

Removes one of the authenticated user's watchlist entries. Users can only delete their own entries.

Response

Self-booking role behaviour (/schedules/edit.json)

The schedule create/edit endpoint applies these role rules to self-bookings (self_schedule = 1):

User group
Behaviour

Students (user_group_id > 190)

Can never be PIC. Stored as SIC (sic_status ACCEPTED). The system auto-assigns an available FI as PIC (pic_status PENDING, status SCHEDULED). When no FI is available, the booking is saved with status PENDING and an empty PIC. Students are exempt from the certificate gate below.

Pilots (user_group_id 171–190)

Unchanged: the user making the reservation is the PIC.

FIs / staff (user_group_id <= 170, pilot = true)

Fly as PIC. May pass another pilot in pic_id: it is stored as SIC with the instructor as PIC, saved directly as SCHEDULED.

PENDING bookings are auto-assigned when a matching FI publishes AVAILABLE/ALWAYS availability (/schedules/add_availability.json, /schedules/edit_availability.json — response field assignedPending), and auto-canceled by the cron when start - schedule_flight_cancellation_min_time (hours) is reached.

Certificate gate on self-bookings

A self-booking (self_schedule = 1) is rejected on the pilot's own certificates only when both company settings line up:

schedule_self_allow_nodocs is the self-booking override: when it is 1, a pilot whose licence, rating or medical is missing or expired can still create the booking. Both settings are returned by GET /companies/settings.json under CompanySetting.

The gate applies to pilots with pilot = true and 149 < user_group_id <= 190. Managers (user_group_id <= 149), students (> 190) and non-pilots are never gated. Validity is evaluated with the same rule as checkValidLicence (a certificate is valid when issue is empty or past and expiration is empty or future).

When the gate rejects the booking:

block_pic_without_docs does not apply here — it gates manager schedule edits and flight dispatch, not self-bookings.

Clients should mirror this rule rather than blocking on certificate state alone: warn the pilot whenever documents are invalid, but keep the booking action available unless require_pic_docs = 1 and schedule_self_allow_nodocs = 0. The same applies to the per-seat flight-type requirements returned by GET /flight_types/compliance/{id}.json — a non-compliant seat is a warning, and only that setting combination makes it a hard stop.

Last updated