--- title: "Read one Company Domain" method: GET path: "/domains/{domain}" tags: ["domains"] --- # Read one Company Domain `GET /domains/{domain}` ## Request - Base URL: `https://api.sparkvault.com/v1` - URL: `https://api.sparkvault.com/v1/domains/{domain}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) One of the organization's domains: whether it still holds the domain's claim, what the domain can do, the records it publishes and the last DNS check (org admins only). ## Path parameters - `domain` string, required ## Response `200` The domain. - object - `data` DomainAnswer, required - `domain` DomainStatus, required: One of the organization's Company Domains: the entry it added, whether it still holds the domain's claim, what the domain can do, the records it publishes, each with what the last DNS check found, and that check. A domain whose claim is missing or another organization's answers `claimed: false` and reads as the entry's own verified state, never another organization's capabilities; nothing else in the answer tells the two apart. - `domain` string, required: The domain, lowercase. - `verification_method` 'dns_txt' - `txt_name` string: The ownership record's name: `_sparkvault.{domain}`. - `txt_value` string: The ownership record's value. - `created_at` integer: Unix seconds. - `verified_at` integer: Unix seconds: when the ownership record was proven. - `claimed` boolean, required: Whether the organization holds the domain's claim. False: the claim that proves the organization owns the domain is missing or another organization's; remove the domain and add it again to prove ownership. - `zone_apex` boolean, nullable, required: Whether the domain is its own DNS zone; null until a check learns it. A zone apex cannot carry a help desk; Notify can send from one. - `ownership` object, required - `status` 'verified' | 'lapsed' - `last_checked_at` integer, nullable - `last_ok_at` integer, nullable - `lapse_started_at` integer, nullable: The first check that found the ownership record missing; missing for 24 hours, ownership lapses. - `email` object, required - `sending` object - `status` 'not_requested' | 'pending_dns' | 'ready' | 'degraded' | 'failed' | 'paused' - `ready_at` integer, nullable - `last_checked_at` integer, nullable - `error` string, nullable: Why sending is where it is: dkim_failed, identity_missing or setup_failed (failed), dkim_record_missing, verification_interrupted or verification_pending (degraded or waiting), products_lapsed (paused while the organization holds neither the Secure Help Desk nor Notify, whose capability it is; a check once it holds either resumes sending). - `receiving` object - `status` 'not_requested' | 'pending_dns' | 'probing' | 'ready' | 'degraded' - `ready_at` integer, nullable - `last_checked_at` integer, nullable - `error` string, nullable - `mail_from` object - `status` 'off' | 'pending' | 'ready' | 'failed' - `domain` string, nullable - `web` object, required - `status` 'not_requested' | 'pending' | 'ready' | 'moved' - `target` string: The CNAME target every help-desk domain points at. - `last_checked_at` integer, nullable - `email_sending_ready` boolean, required - `email_receiving_ready` boolean, required - `web_ready` boolean, required - `help_desk_selectable` boolean, required: Whether the mail product `help_desk` may select the domain: its ownership verified, its email sending ready and its web host live, on a domain that is not a zone apex. - `notify_selectable` boolean, required: Whether the mail product `notify` may select the domain: its ownership verified and its email sending ready, a zone apex included. - `records` object[], required: Every record the domain publishes for what it set up, in the order the console shows them. - `id` string, required: ownership, dkim1 to dkim3, web, mail_from_mx or mail_from_spf. - `host` string, required - `type` 'TXT' | 'CNAME' | 'MX', required - `value` string, required - `purpose` string, required - `status` 'ok' | 'propagating' | 'missing' | 'wrong' | 'proxied' | 'unreachable' | 'not_checked', required - `diagnosis` object, nullable, required: The last check: the zone it found and, per record, what each authoritative nameserver answered (`observed_by_nameserver`, with an `error` naming a nameserver that did not answer). Null before any check. - `email_setup_available` boolean, required: Whether email setup is offered: the organization holds the Secure Help Desk or Notify, and the platform can set it up. - `meta` ResponseMeta: Envelope metadata present on every successful response. - `api_version` string - `request_id` string - `response_ms` integer - `timestamp` integer: Unix seconds. - `pools` object: Storage and bandwidth capacity snapshot for the account. - `billing` object - `past_due` boolean - `quota` object: This minute of the account request budget. Present on authenticated success responses that passed the throttle; absent otherwise. - `limit` integer - `used` integer - `remaining` integer - `resets_at` integer: Unix seconds. ## Other responses - `401`: AUTHENTICATION_ERROR — missing or invalid credentials. - `403`: FORBIDDEN — the caller is not an org admin. - `404`: NOT_FOUND — the organization lists no such domain. - `429`: RATE_LIMIT_EXCEEDED — the account exceeded 5000 requests this minute. `Retry-After` carries the seconds to wait, and `details` carries limit/resets_at, plus `used` whenever the request was counted. A request refused because the limiter itself was unavailable reports no `used`. ## Changes - **2026-10-28** `a9a10e328ba5`: 16 info - the response property `error/details` became required for the status `401` - the response property `error/details` became required for the status `403` - the response property `error/details` became required for the status `404` - the response property `error/details` became required for the status `429` - …12 more - **2026-10-28** `56d7c265a77a`: 4 breaking, 1 info - the response property `error/details` became nullable for the status `401` - the response property `error/details` became nullable for the status `403` - the response property `error/details` became nullable for the status `404` - the response property `error/details` became nullable for the status `429` - …1 more - **2026-10-21** `9f5e902abd83`: 1 info - endpoint added [Operation history](https://skmtc.dev/sparkvault/apis/sparkvault-api/changes/domains/:domain/get.md) --- [API](https://skmtc.dev/sparkvault/apis/sparkvault-api.md) - [All operations](https://skmtc.dev/sparkvault/apis/sparkvault-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sparkvault/apis/sparkvault-api/revisions/97cfadccd0c0?raw)