Ampersand · Schema

ClaimedDomainResponse

ClaimedDomainResponse schema from Ampersand API

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
id string Unique identifier for the claimed domain
parentType string Type of the parent entity that claimed the domain
parentId string ID of the parent entity that claimed the domain
domain string The normalized domain name
View JSON Schema on GitHub

JSON Schema

ampersand-api-claimed-domain-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-claimed-domain-response-schema.json",
  "title": "ClaimedDomainResponse",
  "description": "ClaimedDomainResponse schema from Ampersand API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the claimed domain",
      "example": "00000000-0000-0000-0000-000000000001"
    },
    "parentType": {
      "type": "string",
      "description": "Type of the parent entity that claimed the domain",
      "example": "org"
    },
    "parentId": {
      "type": "string",
      "description": "ID of the parent entity that claimed the domain",
      "example": "00000000-0000-0000-0000-000000000001"
    },
    "domain": {
      "type": "string",
      "description": "The normalized domain name",
      "example": "xyz.com"
    }
  },
  "required": [
    "id",
    "parentType",
    "parentId",
    "domain"
  ]
}