---
title: "Get a domain"
method: GET
path: "/customers/{id}/domains/{domain}"
tags: ["Partners"]
---

# Get a domain

`GET /customers/{id}/domains/{domain}`

## Request

- Base URL: `https://faivelo.com/api/partner`
- URL: `https://faivelo.com/api/partner/customers/{id}/domains/{domain}`
- Auth: HTTP bearer

Domain status and records. With `verify=true` live DNS is checked now; otherwise the stored state is returned. Requires `partner:read`.

## Path parameters

- `id` string, required
- `domain` string, required

## Query parameters

- `verify` boolean

## Response `200`

Domain status

- object
  - `success` boolean
  - `data` PartnerDomainStatus
    - `domain` string
    - `verified` boolean
    - `brandName` string, nullable
    - `mailboxes` integer
    - `createdAt` string, date-time
    - `dnsRecords` PartnerDnsRecord[]: Show these to the customer; poll with `verify=true` until every record is verified
      - `type` string
      - `name` string
      - `value` string
      - `verified` boolean
      - `lastCheck` string, date-time, nullable
    - `storage` StorageSummary, nullable: Bytes used and allowed. Null when the mail server could not answer.
      - `usedBytes` integer
      - `limitBytes` integer, nullable
      - `availableBytes` integer, nullable
    - `storageLimitBytes` integer, nullable: The cap you set, or null when only the plan storage applies
    - `plan` 'STARTER' | 'GROWTH' | 'PRO' | 'BUSINESS': The plan this domain is billed at; it sets the storage shared by its mailboxes, contacts and Drive
    - `conflicts` unknown[]: Existing records at the host that clash with the required ones (only populated when `verify=true`)
      - unknown

## Other responses

- `401`: Missing or invalid API key, or not a partner key
- `403`: The key lacks the required scope, or provisioning is refused (partner paused, customer cap reached)
- `404`: Not found, including any customer that is not yours
- `429`: Rate limit exceeded

---

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