API Reference

Get list of alert mutes for account or entity

get
https://api.mesh.complyadvantage.com/v3/alerts/mutes

Get list of alert mutes for the current client account, or filtered by a specific entity (customer, counterparty or agent). entity_identifier and entity_type must be provided together or both omitted. Results are paginated; use page and size parameters to navigate pages.

You need the "View alerts" permission to use this endpoint.

Query Params
string

Optional identifier/profile id of the entity to filter alert mutes

string
enum

Entity type, required when entity_identifier is specified, and must not be provided without it. One of: CUSTOMER, COUNTERPARTY

Allowed:
integer
≥ 1
Defaults to 1

One-based page index (1..N)

integer
≥ 1
Defaults to 50

The size of the page to be returned

sort
array of strings
Defaults to []

Sorting criteria in the format of: [-]property (- descending modifier).

  • Default sort order is ascending (without -).

  • Multiple sort criteria are supported.

sort
Responses

Updated 4 days ago

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

Updated 4 days ago