Your organization's domain

An organization claims the domain it operates as. Its accounts use that domain: a buyer account as its operator domain, with its own operating-unit code, and a seller account as its brand domain. See Which domain is which for how this differs from the domains used for sign-in. This route needs a signed-in person: the web app, or an assistant connected with your Apostra sign-in. API keys and other machine credentials are refused.

Read the organization’s domains

GET /api/v2/accounts/{customerId}/organization-domains customerId is the organization. An administrator of the organization can read it, and so can Apostra staff supporting the organization.

{
  "data": {
    "domains": [
      {
        "domain": "acme.com",
        "state": "verified",
        "proofMethod": "staff_review",
        "provedAt": "2026-10-24T21:09:53.598Z",
        "accountIds": ["804", "805"]
      }
    ]
  },
  "error": null
}

Field	Type	Notes
`data.domains`	array	The organization’s claimed domains. Empty when it claims none
`data.domains[].domain`	string	The claimed domain
`data.domains[].state`	string	`claimed` (saved, not proved), `verifying` (a DNS check is open) or `verified`
`data.domains[].proofMethod`	string \| null	`dns_txt`, `staff_review` or `aao_sign_in` once verified, otherwise `null`
`data.domains[].provedAt`	string \| null	When it was proved, otherwise `null`
`data.domains[].accountIds`	array	The organization’s accounts that use the domain

Errors

401 UNAUTHORIZED: no signed-in person.
403 ACCESS_DENIED: the caller is neither an administrator of the organization nor Apostra staff supporting it, or used an API key.
404 NOT_FOUND: the account is not an active organization.

Claiming a domain

Claiming or changing the organization’s domain is not available through the API yet. It arrives with the organization’s Domains page, together with the proof checks that make sure only one organization can verify a domain. Until then, ask Apostra to record or change your organization’s claim.

Verify operator domain

Prove control of the domain

Which domain is which

Sign-in, operator and brand domains

Start building

Core Concepts

Buyer operations

Seller operations

Cross-Cutting Reference

Buyer API reference

Seller API reference

Release Notes

Your organization's domain

Read the organization’s domains

Errors

Claiming a domain

Verify operator domain

Which domain is which

​Read the organization’s domains

​Errors

​Claiming a domain

​Related

Verify operator domain

Which domain is which

Read the organization’s domains

Errors

Claiming a domain

Related