---
title: "Get a list of domains"
method: GET
path: "/domains"
tags: ["domains"]
---

# Get a list of domains

`GET /domains`

## Request

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

Returns a list of domains for your account.

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

## Query parameters

- `active` boolean
- `inactive` boolean
- `labels` string[]
- `asset_portfolio_names` string[]
- `page_token` string
- `page_size` integer
- `sort_by` 'domain' | 'active' | 'automated_score' | 'scanned_at'
- `sort_desc` boolean

## Response `200`

A list of domains

- GetDomainsV1RespBody
  - `domains` Domain[]: The list of domains
    - `active` boolean: The status of the domain
    - `automated_score` integer: The score of the domain. If the domain is active or hasn't been scanned yet this field will be absent
    - `hostname` string: The hostname
    - `labels` string[]: The labels associated with the domain
    - `primary_domain` boolean: Flag indicating the primary domain for the account
    - `scanned_at` string, date-time: The time the domain was scanned. If the domain is inactive or hasn't been scanned yet this field will be absent
  - `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 domains found.

## Other responses

- `403`: Your API key does not have permission to perform this action.
- `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
  - added the new optional `query` request parameter `asset_portfolio_names`

[Operation history](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/changes/domains/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)