---
title: "Get Domains"
method: GET
path: "/waap/v1/domains"
tags: ["Domains"]
---

# Get Domains

`GET /waap/v1/domains`

Retrieve a list of domains associated with the client

## Query parameters

- `ordering` 'id' | 'name' | 'status' | 'created_at' | '-id' | '-name' | '-status' | '-created_at' — Sort the response by given field.
- `limit` integer — Number of items to return
- `offset` integer — Number of items to skip
- `status` 'active' | 'bypass' | 'monitor' | 'locked' — The different statuses a domain can have
- `name` string — Filter domains based on the domain name. Supports '*' as a wildcard character
- `ids` integer[] — Filter domains based on their IDs

## Response `200`

Successful Response

- PaginatedResponseSummaryDomainResponse
  - `limit` integer, required — Number of items requested in the response
  - `offset` integer, required — Items response offset used
  - `count` integer, required — Number of items contain in the response
  - `results` SummaryDomainResponse[], required — List of items returned in the response following given criteria
    - `id` integer, required — The domain ID
    - `name` string, required — The domain name
    - `status` 'active' | 'bypass' | 'monitor' | 'locked', required — The different statuses a domain can have
    - `custom_page_set` integer, nullable, required — The ID of the custom page set
    - `created_at` string, date-time, required — The date and time the domain was created in ISO 8601 format
    - `aliases` string[] — CNAME aliases pointing at this domain's CDN resource

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Unauthenticated
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/g-core/apis/gcore-openapi.md) · [All operations](https://skmtc.net/g-core/apis/gcore-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/g-core/gcore-openapi/revisions/09e652815095/schema)