Get all records in watchlist

get

https://api.spycloud.io/enterprise-v2/breach/data/watchlist

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

enum

This parameter lets you filter results by type. The allowed values are corporate (corporate records), infected (infected user records from botnet data), email_domain (records associated with a specific email domain), and target_domain (records associated with a monitored/target domain). If no value is provided, the API will return all record types by default.

Allowed:

watchlist_type

string

enum

This parameters lets you filter results for only emails or only domains on your watchlist. The allowed values are: ['email', 'domain', 'subdomain', 'ip']. If no value has been provided, the API will return all watchlist types.

Allowed:

cursor

string

Token used for iterating through multiple pages of results.

since

date

This parameter allows you to define the starting point for a date range query on the spycloud_publish_date field in either format for date YYYY-MM-DD or datetime YYYY-MM-DDThh:mm:ss[z]

until

date

This parameter allows you to define the ending point for a date range query on the spycloud_publish_date field in either format for date YYYY-MM-DD or datetime YYYY-MM-DDThh:mm:ss[z]

since_modification_date

date

This parameter allows you to define the starting point for a date range query on the when an already published record was modified (record_modification_date). Format for date YYYY-MM-DD or datetime YYYY-MM-DDThh:mm:ss[z]

until_modification_date

date

This parameter allows you to define the ending point for a date range query on the when an already published record was modified (record_modification_date). Format for date YYYY-MM-DD or datetime YYYY-MM-DDThh:mm:ss[z]

severity

string

One or more comma delimited numeric severity code to filter based on the severity.

source_id

string

This parameter allows you to filter based on a particular breach source. A comma separated list of source ids can also be used

salt

string

If hashing is enabled for your API key, you have the option to provide a 10 to 24 character, high entropy salt otherwise the pre-configured salt will be used.

Responses

200OK

201Accepted

204Deleted

400Bad Request

403Forbidden

429Rate Limit Exceeded

500Internal Server Error

504Gateway Timeout