---
title: "GET /user/domains"
method: GET
path: "/user/domains"
---

# GET /user/domains

`GET /user/domains`

## Request

- Base URL: `https://developers.whmcs.com/api/v2`
- URL: `https://developers.whmcs.com/api/v2/user/domains`
- Auth: none declared

Retrieve all domains for the authenticated client.

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

A list of all domains

- object
  - `data` DomainRenewal[], required
    - `domain_name` string, required
    - `id` integer, required: the unique ID for the domain within the application
    - `status` 'Active' | 'Expired' | 'Grace' | 'Redemption' | 'Pending' | 'Cancelled', required: the current status of the domain
    - `expiry_date` string, date, required: the date the domain is due to expire
    - `days_to_expiry` integer: the number of days until the domain expires
    - `days_of_grace_period` integer: the number of days in the grace period after expiry
    - `in_grace_period` boolean: whether the domain is currently within the grace period after expiry
    - `days_of_redemption_period` integer: the number of days in the redemption period after expiry
    - `past_redemption_period` boolean: whether the domain is currently within the redemption period after expiry
    - `days_left_in_period` integer: the number of days left in the current grace or redemption period
    - `in_redemption_period` boolean: whether the domain is currently within the redemption period after expiry
    - `is_premium` boolean: whether the domain is a premium domain
    - `is_expiring_soon` boolean: whether the domain is within the renewal period
    - `eligible_for_renewal` boolean, required: whether the domain is eligible for renewal
    - `free_domain_renewal` boolean: whether the domain renewal is free
    - `renewal_periods` DomainRenewalPricing[], required: the available renewal periods for the domain
      - `period` integer, required
      - `pricing` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix

## Other responses

- `401`: Access Not Authorized
- `default`: General Error

---

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