v13

OpenAPI 3.0.32026-07-31359869.4 MB

domains

List all the domains

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

get/v5/domains

Query parameters

limitnumber

Maximum number of domains to list from a request.

Example:20

Maximum number of domains to list from a request.

sincenumber

Get domains created after this JavaScript timestamp.

Example:1609499532000

Get domains created after this JavaScript timestamp.

untilnumber

Get domains created before this JavaScript timestamp.

Example:1612264332000

Get domains created before this JavaScript timestamp.

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Successful response retrieving a list of domains.

Example response

{
  "domains": [
    {
      "verified": true,
      "nameservers": [
        "ns1.nameserver.net",
        "ns2.nameserver.net"
      ],
      "intendedNameservers": [
        "ns1.vercel-dns.com",
        "ns2.vercel-dns.com"
      ],
      "customNameservers": [
        "ns1.nameserver.net",
        "ns2.nameserver.net"
      ],
      "creator": {
        "id": "ZspSRT4ljIEEmMHgoDwKWDei",
        "username": "vercel_user",
        "email": "demo@example.com"
      },
      "name": "example.com",
      "boughtAt": 1613602938882,
      "createdAt": 1613602938882,
      "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
      "renew": true,
      "serviceType": "zeit.world",
      "transferredAt": 1613602938882,
      "transferStartedAt": 1613602938882
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}