Maintenance

Squawks and maintenance reminders.

13 endpoints · base URL https://api.aerscheduler.com

get/maintenance/reminders

List maintenance reminders

Live reminders across the fleet.

Responses

`200`	OK	The reminders.→ { data: MaintenanceReminder[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/maintenance/reminders \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/maintenance/squawks

List squawks

Reported discrepancies. Visible to technicians, dispatchers, and administrators.

Query parameters

`q`	`string`	Free-text filter. Matches the fields a person would search on.
`resolved`	`boolean`	Filter on resolved state.
`resourceId`	`string`	Comma-separated resource ids.
`startDate`	`string`	Start of the window, ISO 8601. Include an offset or `Z`.
`endDate`	`string`	End of the window, ISO 8601.

Responses

`200`	OK	The squawks.→ { data: Squawk[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/maintenance/squawks \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/maintenance/squawks

Report a squawk

Note the resource is given as a flat resourceId here, where reservations take a nested resource: { id }. That inconsistency is real and is on the list to reconcile.

Request body

The discrepancy.

`title`required	`string`
`description`required	`string`
`resourceId`required	`integer`

Responses

`201`	Created	Success.→ { data: Squawk }
`400`	Bad Request	Validation failed.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/maintenance/squawks \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","description":"…","resourceId":1}'

get/maintenance/reminders/{maintenanceReminderId}

Get a maintenance reminder

One reminder.

Path parameters

maintenanceReminderIdrequired integer The reminder id.

Responses

`200`	OK	Success.→ { data: MaintenanceReminder }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	No such reminder.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/maintenance/reminders/:maintenanceReminderId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/maintenance/reminders/{maintenanceReminderId}

Sign off a maintenance reminder

Marks the work done, which starts the next interval if the template repeats. POST rather than PATCH for historical reasons.

Path parameters

maintenanceReminderIdrequired integer The reminder id.

Request body

Completion detail.

completedAt string

Responses

`200`	OK	Success.→ { data: MaintenanceReminder }
`400`	Bad Request	Validation failed.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/maintenance/reminders/:maintenanceReminderId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"completedAt":"2026-08-04T15:00:00-06:00"}'

get/maintenance/reminders/templates

List reminder templates

Every reminder template in your organization.

Responses

`200`	OK	The reminder templates.→ { data: MaintenanceReminderTemplate[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/maintenance/reminders/templates \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/maintenance/reminders/templates

Create a reminder template

Adds a reminder template to your organization.

Request body

The rule. Set exactly one of remindDays, remindHours, or remindDate, along with its matching *Before field. remindHours is an INTERVAL in hours (every 100), not a flag.

`name`required	`string`
`notes`	`string`
`repeat`required	`boolean`
`ground`	`boolean`
`remindHours`	`integer`
`remindHoursBefore`	`integer`
`hourBasedOn`	`"tach" \| "hobbs"`
`remindDays`	`integer`
`remindDaysBefore`	`integer`
`remindDate`	`string`
`templateResources`	`object[]`

Responses

`201`	Created	The reminder template that was created.→ { data: MaintenanceReminderTemplate }
`400`	Bad Request	The body failed validation. `message` says which field.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/maintenance/reminders/templates \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","repeat":true}'

get/maintenance/squawks/{squawkId}

Get a squawk

One reported discrepancy.

Path parameters

squawkIdrequired integer The squawk id.

Responses

`200`	OK	Success.→ { data: Squawk }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	No such squawk.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/maintenance/squawks/:squawkId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/maintenance/squawks/{squawkId}

Act on a squawk

Resolves or reopens a squawk. This is a POST rather than a PATCH for historical reasons; an action field in the body is required.

Path parameters

squawkIdrequired integer The squawk id.

Request body

What to do.

`action`required	`string`
`title`	`string`
`description`	`string`

Responses

`200`	OK	Success.→ { data: Squawk }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	No such squawk, or no `action` was supplied.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/maintenance/squawks/:squawkId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"…"}'

get/maintenance/reminders/templates/{maintenanceReminderTemplateId}

Get a reminder template

Fetches one reminder template by id.

Path parameters

maintenanceReminderTemplateIdrequired integer The reminder template id.

Responses

`200`	OK	Success.→ { data: MaintenanceReminderTemplate }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	No such reminder template, or it belongs to another organization.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/maintenance/reminders/templates/:maintenanceReminderTemplateId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

patch/maintenance/reminders/templates/{maintenanceReminderTemplateId}

Update a reminder template

Changes the fields you send and leaves the rest alone.

Path parameters

maintenanceReminderTemplateIdrequired integer The reminder template id.

Request body

Fields to change.

`name`	`string`
`notes`	`string`
`repeat`	`boolean`

Responses

`200`	OK	The updated reminder template.→ { data: MaintenanceReminderTemplate }
`400`	Bad Request	The body failed validation.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X PATCH https://api.aerscheduler.com/maintenance/reminders/templates/:maintenanceReminderTemplateId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","notes":"…"}'

delete/maintenance/reminders/templates/{maintenanceReminderTemplateId}

Delete a reminder template

Removes the reminder template.

Path parameters

maintenanceReminderTemplateIdrequired integer The reminder template id.

Responses

`204`	No Content	Success. No body.
`400`	Bad Request	The reminder template could not be deleted — usually because something still references it.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X DELETE https://api.aerscheduler.com/maintenance/reminders/templates/:maintenanceReminderTemplateId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/maintenance/resources/{resourceId}/squawks

List an aircraft's squawks

Discrepancies against one resource.

Path parameters

resourceIdrequired integer The resource id.

Query parameters

resolved boolean Filter on resolved state.

Responses

`200`	OK	The squawks.→ { data: Squawk[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/maintenance/resources/:resourceId/squawks \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

PreviousResourcesAircraft, simulators, and rooms.NextInvoicesBilling for completed flights.