/api/notification/admin

GET /api/notification/admin

Changed on

List card-type notifications (alerts) for admin management. Supports pagination (limit + offset query params — handled by the offset-paging middleware), filtering, and sorting.

last_send_status filter operates on the latest channel-send task_history row for the notification (successful = latest channel-send succeeded; failing = latest channel-send failed).

last_check_status filter operates on the latest terminal TaskRun for the notification — the whole-run rollup (successful = the run succeeded; failing = it failed or was abandoned). This is a superset of last_send_status: it also catches query failures and heartbeat-abandoned runs that never reached the send step. The Failing tab uses ?last_check_status=failing.

creatorless=true selects notifications with no creator or a deactivated creator (the Ownerless tab). creatorless=false selects the inverse.

channel accepts a single string or a repeated query param for multi-select (OR logic).

get/api/notification/admin

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Query parameters

recipient_emailstring

value must be a non-blank string.

querystring

value must be a non-blank string.

creatorlessboolean nullable

value must be a valid boolean string ('true' or 'false').

last_check_status'failing' | 'successful'
creator_activeboolean nullable

value must be a valid boolean string ('true' or 'false').

card_idinteger

value must be an integer greater than zero.

last_send_status'failing' | 'successful'
string

value must be a non-blank string.

OR
string[]
activeboolean nullable

value must be a valid boolean string ('true' or 'false').

sort_column'id' | 'last_send' | 'last_check' | 'card_name' | 'creator_name' | 'updated_at'
creator_idinteger

value must be an integer greater than zero.

sort_direction'asc' | 'desc'

Response

Successful response

limitinteger nullable required

value must be an integer greater than zero.

offsetinteger nullable required

value must be an integer greater or equal to than zero.

totalinteger required

value must be an integer greater or equal to than zero.

Changes