Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Alerts & Risks

Get list of alert mutes for account or entity

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.

get/v3/alerts/mutes

Query parameters

entity_identifierstring

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

entity_type'CUSTOMER' | 'COUNTERPARTY'

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

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

sortstring[]

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

  • Default sort order is ascending (without -).

  • Multiple sort criteria are supported.

Response

List of found alert mutes for account or entity

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger nullable

Total number of items.

Example response

{
  "alert_mutes": [
    {
      "created_at": "2026-03-10T14:55:17.835Z",
      "created_by": "019cd83e-c008-71ca-b7d8-4b834b516614",
      "entity": {
        "identifier": "89013cff-8b3a-4301-bb59-c20f1d381c20",
        "type": "CUSTOMER"
      },
      "identifier": "1cf055ed-f05d-4814-902f-654668b12910",
      "risk_code": "PEP",
      "risk_signal_identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "first": "/v1/resource?page_number=1",
  "next": "/v1/resource?page_number=4",
  "prev": "/v1/resource?page_number=2",
  "self": "/v1/resource?page_number=3",
  "total_count": 60
}