GET
/
v1
/
domains
/
{domain}
/
registry
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.domains.getDomainTransfer({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    domain: "example.com",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "transferable": true,
  "transferPolicy": "charge-and-renew",
  "reason": "<string>",
  "status": "pending_owner"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
domain
string
required
Example:

"example.com"

Query Parameters

​
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
​
transferable
boolean
required

Whether or not the domain is transferable

​
transferPolicy
enum<string> | null
required

The domain's transfer policy (depends on TLD requirements). charge-and-renew: transfer will charge for renewal and will renew the existing domain's registration. no-charge-no-change: transfer will have no change to registration period and does not require charge. no-change: transfer charge is required, but no change in registration period. new-term: transfer charge is required and a new registry term is set based on the transfer date. not-supported: transfers are not supported for this domain or TLD. null: This TLD is not supported by Vercel's Registrar.

Available options:
charge-and-renew,
no-charge-no-change,
no-change,
new-term,
not-supported
​
reason
string
required

Description associated with transferable state.

​
status
enum<string>
required

The current state of an ongoing transfer. pending_owner: Awaiting approval by domain's admin contact (every transfer begins with this status). If approval is not given within five days, the transfer is cancelled. pending_admin: Waiting for approval by Vercel Registrar admin. pending_registry: Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar). completed: The transfer completed successfully. cancelled: The transfer was cancelled. undef: No transfer exists for this domain. unknown: This TLD is not supported by Vercel's Registrar.

Available options:
pending_owner,
pending_admin,
pending_registry,
completed,
cancelled,
undef,
unknown