UPupguard
breaches

Get a list of breached identities

Returns a list of identities ordered by last breached date.

Required API key permissions: IdentityBreaches (select when creating API key in Account Settings)

get/breaches

Request

Query parameters

page_tokenstring

The page_token from a previous request, use this to get the next page of results.

page_sizeinteger

The number of results to return per page.

sort_by'name' | 'domain' | 'num_breaches' | 'date_last_breach'

The value to sort the breached identities by

If not specified will default to date_last_breach and set sort_desc to true

sort_descboolean

Whether or not to sort the results in descending order

breach_idstring

The breach ID to filter on

Response

A list of breached identities

next_page_tokenstring

The token to be used to retrieve the next page of results. Will not be returned if there are no more results.

total_resultsinteger

The total number of breached identities found.

Example response

{
  "breached_identities": [
    {
      "breach_ids": [
        42,
        89
      ],
      "domain": "example.com",
      "id": 101,
      "last_breach_date": "2019-11-09T03:48:57Z",
      "name": "jane.smith",
      "num_breaches": 42,
      "severity": "High"
    }
  ],
  "breaches": [
    {
      "assignee_user_email": "viggo@example.com",
      "breach_status": "active",
      "breach_type": "Company",
      "date_notified": "2019-11-09T03:48:57Z",
      "date_occurred": "2019-11-09T03:48:57Z",
      "date_published": "2019-11-09T03:48:57Z",
      "description": "In November 2019, all customer records of Acme Inc. were made publicly available for 13 hours.",
      "domain": "acme.com",
      "employee_count": 10,
      "exposed_data_classes": [
        "Passwords",
        "Usernames",
        "Email addresses",
        "Social security numbers",
        "Banking PINs",
        "Credit cards"
      ],
      "id": 101,
      "name": "AcmeInc",
      "severity": "High",
      "title": "Acme Inc.",
      "total_exposures": 9673824
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.