read_domains
Read the workspace's existing domains, registration progress, and outbound transfers.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## read_domains
Read the workspace's existing domains, registration progress, and outbound transfers.
Use to inspect domains a workspace already owns and their state.
New domain purchases are no longer available.
Scopes: domain:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"list"
]
},
"cursor": {
"$ref": "#/$defs/Cursor"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"kind"
],
"patternProperties": {
"^(?!(?:kind|cursor|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"cursor",
"limit"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"get"
]
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"domainId"
],
"patternProperties": {
"^(?!(?:kind|domainId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"domainId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"registration_status"
]
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"domainId"
],
"patternProperties": {
"^(?!(?:kind|domainId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"domainId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"transfer_status"
]
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"domainId"
],
"patternProperties": {
"^(?!(?:kind|domainId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"domainId"
]
}
}
]
}
},
"required": [
"workspaceId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action"
]
},
"$defs": {
"Cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"list"
]
},
"cursor": {
"$ref": "#/$defs/Cursor"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"kind"
],
"patternProperties": {
"^(?!(?:kind|cursor|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"cursor",
"limit"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"get"
]
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"domainId"
],
"patternProperties": {
"^(?!(?:kind|domainId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"domainId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"registration_status"
]
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"domainId"
],
"patternProperties": {
"^(?!(?:kind|domainId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"domainId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"transfer_status"
]
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"domainId"
],
"patternProperties": {
"^(?!(?:kind|domainId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"domainId"
]
}
}
]
}
},
"required": [
"workspaceId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action"
]
},
"$defs": {
"Cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"DomainName": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"Money": {
"type": "object",
"properties": {
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLE",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UYW",
"UZS",
"VED",
"VES",
"VND",
"VUV",
"WST",
"XAD",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XCG",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWG"
]
}
},
"required": [
"amountMinor",
"currency"
],
"patternProperties": {
"^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"amountMinor",
"currency"
]
}
},
"Description": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"Cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"OpaqueId": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"domainName": {
"$ref": "#/$defs/DomainName"
},
"registrar": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"registering",
"renew_option_pending",
"active",
"renewal_due",
"transfer_pending",
"transferred_out",
"expired",
"failed"
]
},
"registeredAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"autoRenew": {
"type": "boolean"
},
"dnsProvider": {
"$ref": "#/$defs/ShortText"
},
"purchasePrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"renewalPrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"failureReason": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
]
}
}
},
"nextCursor": {
"anyOf": [
{
"$ref": "#/$defs/Cursor"
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"nextCursor"
],
"patternProperties": {
"^(?!(?:items|nextCursor)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"nextCursor"
]
}
},
{
"type": "object",
"properties": {
"domain": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"domainName": {
"$ref": "#/$defs/DomainName"
},
"registrar": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"registering",
"renew_option_pending",
"active",
"renewal_due",
"transfer_pending",
"transferred_out",
"expired",
"failed"
]
},
"registeredAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"autoRenew": {
"type": "boolean"
},
"dnsProvider": {
"$ref": "#/$defs/ShortText"
},
"purchasePrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"renewalPrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"failureReason": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
]
}
},
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/OpaqueId"
},
"kind": {
"type": "string",
"enum": [
"registration",
"renewal"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"paid",
"fulfilled",
"failed",
"refund_pending",
"refunded"
]
},
"years": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"amount": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"kind",
"status",
"years",
"amount",
"error",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|kind|status|years|amount|error|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"status",
"years",
"amount",
"error",
"createdAt"
]
}
},
"maxItems": 100
}
},
"required": [
"domain",
"orders"
],
"patternProperties": {
"^(?!(?:domain|orders)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"domain",
"orders"
]
}
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"idle",
"running",
"reconciling"
]
},
"progress": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"progress",
"message"
],
"patternProperties": {
"^(?!(?:state|progress|message)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"state",
"progress",
"message"
]
}
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"registering",
"renew_option_pending",
"active",
"renewal_due",
"transfer_pending",
"transferred_out",
"expired",
"failed"
]
},
"rawStatus": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"changed": {
"type": "boolean"
}
},
"required": [
"status",
"rawStatus",
"changed"
],
"patternProperties": {
"^(?!(?:status|rawStatus|changed)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"status",
"rawStatus",
"changed"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"domainName": {
"$ref": "#/$defs/DomainName"
},
"registrar": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"registering",
"renew_option_pending",
"active",
"renewal_due",
"transfer_pending",
"transferred_out",
"expired",
"failed"
]
},
"registeredAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"autoRenew": {
"type": "boolean"
},
"dnsProvider": {
"$ref": "#/$defs/ShortText"
},
"purchasePrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"renewalPrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"failureReason": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
]
}
}
},
"nextCursor": {
"anyOf": [
{
"$ref": "#/$defs/Cursor"
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"nextCursor"
],
"patternProperties": {
"^(?!(?:items|nextCursor)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"nextCursor"
]
}
},
{
"type": "object",
"properties": {
"domain": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"domainName": {
"$ref": "#/$defs/DomainName"
},
"registrar": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"registering",
"renew_option_pending",
"active",
"renewal_due",
"transfer_pending",
"transferred_out",
"expired",
"failed"
]
},
"registeredAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"autoRenew": {
"type": "boolean"
},
"dnsProvider": {
"$ref": "#/$defs/ShortText"
},
"purchasePrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"renewalPrice": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"failureReason": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"domainName",
"registrar",
"status",
"registeredAt",
"expiresAt",
"autoRenew",
"dnsProvider",
"purchasePrice",
"renewalPrice",
"failureReason",
"createdAt"
]
}
},
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/OpaqueId"
},
"kind": {
"type": "string",
"enum": [
"registration",
"renewal"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"paid",
"fulfilled",
"failed",
"refund_pending",
"refunded"
]
},
"years": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"amount": {
"anyOf": [
{
"$ref": "#/$defs/Money"
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"kind",
"status",
"years",
"amount",
"error",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|kind|status|years|amount|error|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"status",
"years",
"amount",
"error",
"createdAt"
]
}
},
"maxItems": 100
}
},
"required": [
"domain",
"orders"
],
"patternProperties": {
"^(?!(?:domain|orders)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"domain",
"orders"
]
}
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"idle",
"running",
"reconciling"
]
},
"progress": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"progress",
"message"
],
"patternProperties": {
"^(?!(?:state|progress|message)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"state",
"progress",
"message"
]
}
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"registering",
"renew_option_pending",
"active",
"renewal_due",
"transfer_pending",
"transferred_out",
"expired",
"failed"
]
},
"rawStatus": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"changed": {
"type": "boolean"
}
},
"required": [
"status",
"rawStatus",
"changed"
],
"patternProperties": {
"^(?!(?:status|rawStatus|changed)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"status",
"rawStatus",
"changed"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `domains.list`: `GET /v1/workspaces/:workspaceId/domains`
- `domains.get`: `GET /v1/workspaces/:workspaceId/domains/:domainId`
- `domains.registrationStatus`: `GET /v1/workspaces/:workspaceId/domains/:domainId/registration-status`
- `domains.transferStatus`: `GET /v1/workspaces/:workspaceId/domains/:domainId/transfer-status`
Scheduler Zero