GET
/
v1
/
breaches
/
{breach_id}
/
compromised-employees
List compromised employees for a breach
curl --request GET \
  --url https://public-api.tryriot.com/v1/breaches/{breach_id}/compromised-employees \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "acknowledged_at": "2024-01-13T10:05:00.000000Z",
      "breached_accounts": [
        {
          "compromised_at": "2024-01-13T10:00:00.000000Z",
          "email": "[email protected]"
        }
      ],
      "compromised_at": "2024-01-13T10:00:00.000000Z",
      "employee": {
        "id": "e4ebfd69-3c2c-4028-b423-1bff3d87d58f",
        "name": "John Doe",
        "primary_email_address": "[email protected]",
        "username": "<string>"
      },
      "warned_at": "2024-01-13T10:00:00.000000Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-item-limit
integer
default:50

Maximum number of items to return. Maximum value is 100.

Required range: 1 <= x <= 100
​
x-next-cursor
string

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

Path Parameters

​
breach_id
string<uuid>
required

ID of the breach for which to retrieve compromised employees

Query Parameters

​
workspace_id
string<uuid>
required

ID of the workspace for which to retrieve employees

​
warned
boolean

Filters employees based on whether they have received a notification about the breach. When true, only employees who have been warned will be included. When false, only employees who have not been warned will be included.

​
acknowledged
boolean

Filters employees based on whether they have acknowledged the breach. When true, only employees who have acknowledged the breach will be included. When false, only employees who have not acknowledged the breach will be included.

Response

Compromised employees list for a breach

​
data
PaginatedBreachCompromisedEmployeePayload · object[]
required