Query Breach Alert Subscriptions for Users

Retrieve current user breach alert subscriptions

Returns a paginated list of all user-level alert subscriptions for your account. Can be used to check if a specific user is monitored by using the usernameHash parameter.

GEThttps://api.enzoic.com/v1/breach-monitoring-for-users

Authorization

enzoic_auth

Query parameters

Response

200404

The response body contains the requested results.

Body

application/json

countinteger

The total number of user alert subscription records available across all pages. If this exceeds the requested page size, the results are paginated and a pagingToken will be present in the response.

Example: 1

usernameHashesarray of object

pagingTokenstring

Present when there are additional pages of results available. Pass this token in on a subsequent call to fetch the next page of results.

Example: "5854757a7750ac6c4230f656"

Request

JavaScriptCurlPython

const response = await fetch('https://api.enzoic.com/v1/breach-monitoring-for-users', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200

{
  "count": 1,
  "usernameHashes": [
    {
      "usernameHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "customData": "corporate_users",
      "webhookID": "66766957431c9acc8cea2d6d",
      "webhookURL": "https://mywebhook.com"
    }
  ],
  "pagingToken": "5854757a7750ac6c4230f656"
}