# Breach Catalog

The Breach Catalog lists known breaches you can then search one at a time with `breach_uuid`.

## Endpoint

`GET`

```bash
https://api.webz.io/breachCatalog?token=YOUR_TOKEN&query=linkedin&page=0&size=50
```

## Parameters

| Parameter | Description |
| --- | --- |
| `token` | Your API token. Required. |
| `query` | Free-text search over breach names. Omit to list all. |
| `page` | Zero-based page number. Default `0`. |
| `size` | Results per page, `1`-`100`. Default `100`. |

## Response

```json
{
  "breaches": [
    {
      "breachName": "Example Leak 2023",
      "breachDate": "2023-04-12T00:00:00Z",
      "crawlDate": "2023-05-01T00:00:00Z",
      "compromisedAssets": ["emails", "passwords"],
      "uuid": "0a1b2c3d4e5f60718293a4b5c6d7e8f901234567",
      "total": 152340
    }
  ],
  "total": 1
}
```

| Field | Description |
| --- | --- |
| `breaches[].breachName` | Name of the breach. |
| `breaches[].breachDate` | When the breach occurred. |
| `breaches[].crawlDate` | When Webz.io collected it. |
| `breaches[].compromisedAssets` | Asset types exposed in the breach. |
| `breaches[].uuid` | 40-char hex id. Pass it as `breach_uuid` to `/breaches` (with a domain or email scope). |
| `breaches[].total` | Number of records in the breach. |
| `total` | Total breaches matching `query`. |

> [!NOTE]
> Each Breach Catalog call counts against your search credits.