Notifications

Per-member in-app notifications.

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

get/notifications

List your notifications

Your own in-app notifications.

Query parameters

`q`	`string`	Free-text filter. Matches the fields a person would search on.
`status`	`"unread" \| "read" \| "all"`	Filter by read state. Defaults to `all`.
`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 notifications.→ { data: Notification[] }
`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/notifications \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/notifications

Clear all your notifications

Removes every notification for the signed-in member. A POST rather than a DELETE for historical reasons.

Responses

`204`	No Content	Success. No body.
`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/notifications \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

patch/notifications

Register a push device token

Despite the path, this does not update notifications , it registers a device for push. A separate concern that shares the route for historical reasons.

Request body

The device token.

tokenrequired string

Responses

`200`	OK	Registered.
`400`	Bad Request	No token supplied.
`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/notifications \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"token":"…"}'

post/notifications/{notificationId}

Mark a notification read

A POST rather than a PATCH for historical reasons.

Path parameters

notificationIdrequired integer The notification id.

Responses

`204`	No Content	Success. No body.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	That notification is not yours.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/notifications/:notificationId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

PreviousAnnouncementsNotices to members.NextStandbyStandby interest, cancellation recovery, and time-limited slot offers.

API overview Talk to us