Skip to main content
GET
/
claimed-domains
Check if a domain is claimed
curl --request GET \
  --url https://api.withampersand.com/v1/claimed-domains \
  --header 'X-Api-Key: <api-key>'
{
  "id": "00000000-0000-0000-0000-000000000001",
  "parentType": "org",
  "parentId": "00000000-0000-0000-0000-000000000001",
  "domain": "xyz.com"
}

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
domain
string
required

Accepts an email address, domain name, or URL. The domain will be automatically extracted: for emails, the portion after @ is used (e.g., "user@example.com" becomes "example.com"); for URLs, the hostname is extracted (e.g., "https://www.example.com" becomes "example.com").

Response

Domain claim status

​
id
string
required

Unique identifier for the claimed domain

Example:

"00000000-0000-0000-0000-000000000001"

​
parentType
string
required

Type of the parent entity that claimed the domain

Example:

"org"

​
parentId
string
required

ID of the parent entity that claimed the domain

Example:

"00000000-0000-0000-0000-000000000001"

​
domain
string
required

The normalized domain name

Example:

"xyz.com"

⌘I