---
title: "Get email whitelabel configuration"
method: GET
path: "/api/v1/org/{organizationUuid}/email-whitelabel"
tags: ["Organizations"]
---

# Get email whitelabel configuration

`GET /api/v1/org/{organizationUuid}/email-whitelabel`

Returns the organization's email sending domain configuration, or null if
none has been set up.

## Path parameters

- `organizationUuid` string, uuid, required — Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)

## Response `200`

Ok

- ApiEmailWhitelabelResponse
  - `results` OrganizationEmailWhitelabel, required — The full sender-identity configuration for an organization, as returned to the setup UI. `null` from the API means the org has not started setup.
    - `createdAt` string, date-time, required
    - `lastCheckedAt` string, date-time, nullable, required — Last time the provider was polled for verification, null if never.
    - `dnsRecords` EmailDnsRecord[], required
      - `verified` boolean, required
      - `value` string, required — The value the record must resolve to (right-hand side).
      - `name` string, required — The host / name of the record (left-hand side).
      - `type` 'TXT' | 'CNAME', required
      - `purpose` 'dkim' | 'return-path', required
    - `isEnabled` boolean, required
    - `isVerified` boolean, required — Both DKIM and return-path verified — required before enabling.
    - `returnPathVerified` boolean, required
    - `dkimVerified` boolean, required
    - `status` 'pending' | 'verified' | 'enabled' | 'failed', required — Lifecycle of an organization's sending domain. - `pending` — records handed over, waiting on DNS to propagate & verify. - `verified` — both DKIM and return-path verified, ready to enable. - `enabled` — verified and turned on; report emails send from this domain. - `failed` — verification did not complete within the timeout window; the admin can re-check to restart.
    - `fromName` string, nullable, required — Display name shown in the From header, or null to use the Lightdash default.
    - `fromEmail` string, required — The address emails are sent from, e.g. `reports@customer.com`.
    - `domain` string, required — Domain (or subdomain) emails are sent from, e.g. `reports.customer.com`.
    - `organizationUuid` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)