Skip to main content
GET
/
orgs
/
{orgId}
/
claimed-domains
List organization's claimed domains
curl --request GET \
  --url https://api.withampersand.com/v1/orgs/{orgId}/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

Path Parameters

​
orgId
string
required

Organization ID

Response

List of claimed domains for the organization

​
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"