Availability

When people and aircraft are free.

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

get/availability/me

Your free windows

When you are free in a window, after bookings are subtracted.

Query parameters

`startDate`	`string`	Start of the window, ISO 8601. Include an offset or `Z`.
`endDate`	`string`	End of the window, ISO 8601.

Responses

`200`	OK	Success.→ { data: Availability[] }
`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/availability/me \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/users/availability

Get your recurring availability

Your standing weekly availability pattern.

Responses

`200`	OK	Success.→ { data: Availability[] }
`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/users/availability \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

patch/users/availability

Set your recurring availability

Replaces your standing weekly availability.

Request body

The new pattern.

availability object[]

Responses

`200`	OK	Updated.
`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/users/availability \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"availability":[]}'

get/availability/resource/{id}

A resource's free windows

Used to find an aircraft's open slots before booking.

Path parameters

idrequired integer The resource id.

Query parameters

`startDate`	`string`	Start of the window, ISO 8601. Include an offset or `Z`.
`endDate`	`string`	End of the window, ISO 8601.

Responses

`200`	OK	Success.→ { data: Availability[] }
`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/availability/resource/:id \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/availability/user/{userId}

A person's free windows

Used to find an instructor's open slots.

Path parameters

userIdrequired integer The user id.

Query parameters

`startDate`	`string`	Start of the window, ISO 8601. Include an offset or `Z`.
`endDate`	`string`	End of the window, ISO 8601.

Responses

`200`	OK	Success.→ { data: Availability[] }
`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/availability/user/:userId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

PreviousReservationsBooking, rescheduling, and closing out flights.NextResourcesAircraft, simulators, and rooms.