GET
/
v5
/
domains
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.domains.getDomains({
    limit: 20,
    since: 1609499532000,
    until: 1612264332000,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
{
  "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"
      },
      "teamId": "<string>",
      "createdAt": 1613602938882,
      "boughtAt": 1613602938882,
      "expiresAt": 1613602938882,
      "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
      "name": "example.com",
      "orderedAt": 1613602938882,
      "renew": true,
      "serviceType": "zeit.world",
      "transferredAt": 1613602938882,
      "transferStartedAt": 1613602938882,
      "userId": "<string>"
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
limit
number

Maximum number of domains to list from a request.

Example:

20

​
since
number

Get domains created after this JavaScript timestamp.

Example:

1609499532000

​
until
number

Get domains created before this JavaScript timestamp.

Example:

1612264332000

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json

Successful response retrieving a list of domains.

The response is of type object.

GET
/
v5
/
domains
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.domains.getDomains({
    limit: 20,
    since: 1609499532000,
    until: 1612264332000,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
{
  "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"
      },
      "teamId": "<string>",
      "createdAt": 1613602938882,
      "boughtAt": 1613602938882,
      "expiresAt": 1613602938882,
      "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
      "name": "example.com",
      "orderedAt": 1613602938882,
      "renew": true,
      "serviceType": "zeit.world",
      "transferredAt": 1613602938882,
      "transferStartedAt": 1613602938882,
      "userId": "<string>"
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
limit
number

Maximum number of domains to list from a request.

Example:

20

​
since
number

Get domains created after this JavaScript timestamp.

Example:

1609499532000

​
until
number

Get domains created before this JavaScript timestamp.

Example:

1612264332000

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json

Successful response retrieving a list of domains.

The response is of type object.