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`.

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_TOKEN"

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_TOKEN"

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_TOKEN" \
  -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_TOKEN"

PreviousAnnouncementsNotices to members.NextReportsThe reporting engine and saved views.