List notifications for the authenticated customer

Returns notifications scoped to the authenticated app installation,
ordered by createdAt descending.

The type parameter accepts either a single value (e.g. popover)
or a comma-separated list of types (e.g. popover,card,banner). When
a single value is passed the response is a flat array with cursor
pagination. When multiple values are passed the response is an object
keyed by type, with limit applied independently to each bucket — this
collapses what would otherwise be N separate polls into one round-trip.
Cursor pagination is not supported in multi-type mode.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by notification template type. Accepts a single value or a
comma-separated list (e.g. popover,card,banner). When multiple
values are passed the response shape changes to a per-type
grouped object.

string

Exclude notifications whose template type matches this value.

string

Restrict to notifications addressed to a specific contact email,
or — when there is no contact — falling back to the installation's
customer email.

integer
Defaults to 50

Maximum number of notifications to return. In multi-type mode this
limit is applied independently to each type bucket.

boolean
Defaults to false

When true, include notifications that have been dismissed.

string

Opaque pagination cursor returned from a previous call. Not
supported when type contains multiple values.

Headers
string
required

The App Id when you create an API key in your Mantle dashboard.

string

The App API Key. Required if X-Mantle-Customer-Api-Token is not provided.

string

The customer API token from POST /identify. Required if X-Mantle-App-Api-Key is not provided.

Responses

400

Invalid cursor, or cursor combined with multi-type type.

401

Not authorized.

404

App installation not found.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json