---
title: "Get a list of VIPs"
method: GET
path: "/vips"
tags: ["breaches"]
---

# Get a list of VIPs

`GET /vips`

## Request

- Base URL: `https://cyber-risk.upguard.com/api/public`
- URL: `https://cyber-risk.upguard.com/api/public/vips`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/vips/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of VIPs for your account.

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

## Query parameters

- `page_token` string
- `page_size` integer
- `sort_by` string[]

## Response `200`

A list of VIPs currently monitored for your account

- GetVIPListRespBody
  - `next_page_token` string: The token to be used to retrieve the next page of results. Will not be returned if there are no more results.
  - `total_results` integer: The total number of VIPs found.
  - `vips` VIP[]: The list of VIPs
    - `breach_ids` integer[]: The IDs of the breaches the VIP appears in
    - `date_last_breach` string: The date of the latest breach the VIP appears in (RFC 3339 format).
    - `domain` string: The domain of the VIP
    - `id` integer: The ID of the VIP
    - `name` string: The account name of the VIP
    - `num_breaches` integer: The number of breaches the VIP appears in
    - `severity` string: The highest severity of the breaches the VIP appears in. Will be one of "Critical", "High", "Medium", or "Low".

## Other responses

- `422`: An invalid parameter was supplied or a mandatory parameter was missing
- `429`: Too many requests have been made to this endpoint.
- `500`: An internal system error occurred

## Changes

- **2026-11-07** `d044bf6dc61e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/changes/vips/get.md)

---

[API](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api.md) - [All operations](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/revisions/d044bf6dc61e?raw)