List all the domains

v1.0.0

Retrieves a list of domains registered for the authenticating user. By default it returns the last 20 domains if no limit is provided.

Input

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number",
      "description": "Maximum number of domains to list from a request."
    },
    "since": {
      "type": "number",
      "description": "Get domains created after this JavaScript timestamp."
    },
    "teamId": {
      "type": "string"
    },
    "until": {
      "type": "number",
      "description": "Get domains created before this JavaScript timestamp."
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "domains",
    "pagination"
  ],
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "verified",
          "nameservers",
          "intendedNameservers",
          "creator",
          "createdAt",
          "id",
          "name",
          "expiresAt",
          "boughtAt",
          "serviceType"
        ],
        "properties": {
          "boughtAt": {
            "type": [
              "number",
              "null"
            ],
            "description": "If it was purchased through Vercel, the timestamp in milliseconds when it was purchased."
          },
          "createdAt": {
            "type": "number",
            "description": "Timestamp in milliseconds when the domain was created in the registry."
          },
          "creator": {
            "type": "object",
            "description": "An object containing information of the domain creator, including the user's id, username, and email.",
            "required": [
              "username",
              "email",
              "id"
            ],
            "properties": {
              "customerId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "email": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "isDomainReseller": {
                "type": "boolean"
              },
              "username": {
                "type": "string"
              }
            }
          },
          "customNameservers": {
            "type": "array",
            "description": "A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel.",
            "items": {
              "type": "string"
            }
          },
          "expiresAt": {
            "type": [
              "number",
              "null"
            ],
            "description": "Timestamp in milliseconds at which the domain is set to expire. `null` if not bought with Vercel."
          },
          "id": {
            "type": "string",
            "description": "The unique identifier of the domain."
          },
          "intendedNameservers": {
            "type": "array",
            "description": "A list of the intended nameservers for the domain to point to Vercel DNS.",
            "items": {
              "type": "string"
            }
          },
          "name": {
            "type": "string",
            "description": "The domain name."
          },
          "nameservers": {
            "type": "array",
            "description": "A list of the current nameservers of the domain.",
            "items": {
              "type": "string"
            }
          },
          "orderedAt": {
            "type": "number",
            "description": "Timestamp in milliseconds at which the domain was ordered."
          },
          "renew": {
            "type": "boolean",
            "description": "Indicates whether the domain is set to automatically renew."
          },
          "serviceType": {
            "type": "string",
            "description": "The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available.",
            "enum": [
              "zeit.world",
              "external",
              "na"
            ]
          },
          "transferStartedAt": {
            "type": "number",
            "description": "If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated."
          },
          "transferredAt": {
            "type": [
              "number",
              "null"
            ],
            "description": "Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in."
          },
          "verified": {
            "type": "boolean",
            "description": "If the domain has the ownership verified."
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.",
      "required": [
        "count",
        "next",
        "prev"
      ],
      "properties": {
        "count": {
          "type": "number",
          "description": "Amount of items in the current page."
        },
        "next": {
          "type": [
            "number",
            "null"
          ],
          "description": "Timestamp that must be used to request the next page."
        },
        "prev": {
          "type": [
            "number",
            "null"
          ],
          "description": "Timestamp that must be used to request the previous page."
        }
      }
    }
  }
}