Standby

Standby interest, cancellation recovery, and time-limited slot offers.

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

get/slot-offers

List pending slot offers

Owners, admins, and dispatchers can list pending offers for their organization.

Query parameters

`limit`	`integer`	Rows to return, 1–1000. Defaults to 1000; a larger value is clamped rather than rejected.
`offset`	`integer`	Rows to skip, for paging. Defaults to 0.
`sort`	`string`	Field to order by before paging, as a dot path into the row — `total`, `user.firstName`. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
`order`	`"asc" \| "desc"`	`asc` (default) or `desc`. Only meaningful with `sort`.

Responses

`200`	OK	The pending offers.→ { data: SlotOffer[] }
`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/slot-offers \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/slot-offers

Create a slot offer

Desk staff can offer a slot directly or start recovery from a cancelled reservation.

Request body

The offered window, or a sourceReservationId for recovery.

`sourceReservationId`	`integer`
`offeredToOrgUserId`	`integer`
`start`	`string`
`end`	`string`
`reservationType`	`string`
`timeZoneName`	`string`
`title`	`string`
`resourceId`	`integer`
`instructorOrgUserId`	`integer`
`locationId`	`integer`
`standbyInterestId`	`integer`

Responses

`201`	Created	Success.→ { data: SlotOffer }
`400`	Bad Request	The offer is invalid.
`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/slot-offers \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceReservationId":1,"offeredToOrgUserId":1}'

get/standby

List organization standby interest

Owners, admins, and dispatchers can list standby interest, optionally for one watched reservation.

Query parameters

`reservationId`	`integer`	Only interest watching this reservation.
`limit`	`integer`	Rows to return, 1–1000. Defaults to 1000; a larger value is clamped rather than rejected.
`offset`	`integer`	Rows to skip, for paging. Defaults to 0.
`sort`	`string`	Field to order by before paging, as a dot path into the row — `total`, `user.firstName`. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
`order`	`"asc" \| "desc"`	`asc` (default) or `desc`. Only meaningful with `sort`.

Responses

`200`	OK	The standby interest records.→ { data: StandbyInterest[] }
`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/standby \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/standby

Create standby interest

Creates standby interest for yourself. Owners, admins, and dispatchers may create it for another member.

Request body

The matching criteria.

`orgUserId`	`integer`
`kind`required	`"on_reservation" \| "open_window" \| "standing"`
`watchedReservationId`	`integer`
`start`	`string`
`end`	`string`
`criteria`	`object`
`reservationType`	`string`
`resourceId`	`integer`
`instructorOrgUserId`	`integer`
`priority`	`integer`

Responses

`201`	Created	Success.→ { data: StandbyInterest }
`400`	Bad Request	The matching criteria are invalid.
`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/standby \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"on_reservation"}'

get/slot-offers/me

List my slot offers

Lists every slot offer sent to the signed-in member.

Query parameters

`limit`	`integer`	Rows to return, 1–1000. Defaults to 1000; a larger value is clamped rather than rejected.
`offset`	`integer`	Rows to skip, for paging. Defaults to 0.
`sort`	`string`	Field to order by before paging, as a dot path into the row — `total`, `user.firstName`. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
`order`	`"asc" \| "desc"`	`asc` (default) or `desc`. Only meaningful with `sort`.

Responses

`200`	OK	Your slot offers.→ { data: SlotOffer[] }
`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/slot-offers/me \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

delete/standby/{id}

Withdraw standby interest

Withdraws your own active interest. Desk staff may withdraw any interest in their organization.

Path parameters

idrequired integer The standby interest id.

Responses

`200`	OK	Success.→ { data: StandbyInterest }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`409`		The interest is no longer active.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X DELETE https://api.aerscheduler.com/standby/:id \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

get/standby/me

List my standby interest

Lists standby interest owned by the signed-in member.

Query parameters

`limit`	`integer`	Rows to return, 1–1000. Defaults to 1000; a larger value is clamped rather than rejected.
`offset`	`integer`	Rows to skip, for paging. Defaults to 0.
`sort`	`string`	Field to order by before paging, as a dot path into the row — `total`, `user.firstName`. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
`order`	`"asc" \| "desc"`	`asc` (default) or `desc`. Only meaningful with `sort`.

Responses

`200`	OK	Your standby interest records.→ { data: StandbyInterest[] }
`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/standby/me \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/slot-offers/{id}/accept

Accept a slot offer

Claims a pending offer and creates the corresponding reservation.

Path parameters

idrequired integer The slot offer id.

Responses

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

Example request

curl -X POST https://api.aerscheduler.com/slot-offers/:id/accept \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/slot-offers/{id}/decline

Decline a slot offer

Declines your pending offer and rolls recovery to the next eligible member.

Path parameters

idrequired integer The slot offer id.

Responses

`200`	OK	Success.→ { data: SlotOffer }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`409`		The offer is no longer pending.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/slot-offers/:id/decline \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/slot-offers/{id}/withdraw

Withdraw a slot offer

Desk staff withdraw a pending offer and, for cancellation recovery, roll to the next eligible member.

Path parameters

idrequired integer The slot offer id.

Responses

`200`	OK	Success.→ { data: SlotOffer }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`409`		The offer is no longer pending.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/slot-offers/:id/withdraw \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

PreviousNotificationsPer-member in-app notifications.NextReportsThe reporting engine and saved views.

API overview Talk to us