/api/pulse

Fetch all dashboard subscriptions. By default, returns only subscriptions for which the current user has write permissions. For admins, this is all subscriptions; for non-admins, it is only subscriptions that they created.

If dashboard_id is specified, restricts results to subscriptions for that dashboard.

If created_or_receive is true, it specifically returns all subscriptions for which the current user created or is a known recipient of. Note that this is a superset of the default items returned for non-admins, and a subset of the default items returned for admins. This is used to power the /account/notifications page. This may include subscriptions which the current user does not have collection permissions for, in which case some sensitive metadata (the list of cards and recipients) is stripped out.

get/api/pulse

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

archivedboolean nullable

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

dashboard_idinteger nullable

value must be an integer greater than zero.

creator_or_recipientboolean nullable

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

Response

Successful response

Changes