Get a list of user alerts

Get a list of user alerts.

get/alerts/

Query parameters

pageinteger

cutoffinteger

Unix timestamp of oldest alert to include. Note that unread or unviewed alerts are always included.

unviewedboolean

If true, gets only unviewed alerts. Unviewed alerts have not been seen (in the standard UI).

unreadboolean

If true, gets only unread alerts. Unread alerts may have been seen but the content they relate to has not been viewed.

Response

Changes

Changed in 2 of the 7 revisions of this API.42327

Mar 18, 2026e271d0e41f6d224See the full diff
- ▲
  the alerts/items/ response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ▲
  the pagination response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ○
  api operation id get_alerts_ removed and replaced with getAlerts
  api-operation-id-removed
- ○
  the endpoint scheme security XF-Api-Key was added to the API
  api-security-added
- ○
  the endpoint scheme security XF-OAuth2 was added to the API
  api-security-added
- ○
  added the new optional header request parameter XF-Api-User to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the new optional query request parameter api_bypass_permissions to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the optional property alerts/items/User to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/action to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/alert_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/alert_text to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/alert_url to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/alerted_user_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/auto_read to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/content_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/content_type to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/event_date to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/read_date to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/user_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/username to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property alerts/items/view_date to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property pagination/current_page to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property pagination/last_page to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property pagination/per_page to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property pagination/shown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property pagination/total to the response with the 200 status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 3, 2026fc0a40f3b8592233See the full diff
- ▲
  the alerts/items/ response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ▲
  the pagination response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ●
  the optional response header XF-Latest-Api-Version removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Request-User removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Request-User-Extras removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Used-Api-Version removed for the status 200
  optional-response-header-removed
- ●
  removed the optional property alerts/items/User from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/action from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/alert_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/alert_text from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/alert_url from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/alerted_user_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/auto_read from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/content_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/content_type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/event_date from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/read_date from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/user_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/username from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property alerts/items/view_date from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property pagination/current_page from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property pagination/last_page from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property pagination/per_page from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property pagination/shown from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property pagination/total from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id getAlerts removed and replaced with get_alerts_
  api-operation-id-removed
- ○
  the endpoint scheme security XF-Api-Key was removed from the API
  api-security-removed
- ○
  the endpoint scheme security XF-OAuth2 was removed from the API
  api-security-removed
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history