/api/notification

GET /api/notification

Changed on

List notifications.

  • creator_id: if provided returns only notifications created by this user
  • recipient_id: if provided returns only notification that has recipient_id as a recipient
  • creator_or_recipient_id: if provided returns only notification that has user_id as creator or recipient
  • card_id: if provided returns only notification that has card_id as payload
get/api/notification

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

creator_idinteger

value must be an integer greater than zero.

recipient_idinteger

value must be an integer greater than zero.

creator_or_recipient_idinteger

value must be an integer greater than zero.

card_idinteger

value must be an integer greater than zero.

include_inactiveboolean

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

payload_type'notification/dashboard' | 'notification/system-event' | 'notification/testing' | 'notification/card' nullable

Response

Successful response

Changes