List domains bought through us

Every domain the account bought here, with its end date, auto-renew, the DNS we set and its business email addresses. site_id narrows to one site.

GET/api/v1/domain-names

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the domains:read scope — see connected domains and their DNS records.

domains:readRead onlyMCP tool: list_domain_names

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringQuery · optional: Only this site's.At most 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/domain-names' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{}

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "site_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "expired",
              "failed"
            ]
          },
          "year_cents": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991,
            "description": "What we charge per year (cents), as last quoted."
          },
          "auto_renew": {
            "type": "boolean",
            "description": "Renewed by itself, one year, 30 days before it ends."
          },
          "registered_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "renew_error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "dns_error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "dns_records": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "host": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "answer": {
                  "type": "string"
                }
              },
              "required": [
                "host",
                "type",
                "answer"
              ],
              "additionalProperties": false
            },
            "description": "The records we set at the registrar (host is relative to the domain; empty = the bare domain)."
          },
          "email_forwards": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "box": {
                  "type": "string"
                },
                "to": {
                  "type": "string"
                }
              },
              "required": [
                "box",
                "to"
              ],
              "additionalProperties": false
            },
            "description": "Business email addresses: box@domain arrives in `to`."
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "domain",
          "site_id",
          "status",
          "year_cents",
          "auto_renew",
          "registered_at",
          "expires_at",
          "renew_error",
          "dns_error",
          "dns_records",
          "email_forwards",
          "created_at"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}