Get a project domain | Vercel REST API

APIs & SDKs

Get a project domain

GEThttps://api.vercel.com/v9/projects/{idOrName}/domains/{domain}

Get project domain by project id/name and domain name.

https://api.vercel.com/v9/projects/{idOrName}/domains/{domain}

const response = await fetch('https://api.vercel.com/v9/projects/idOrName/domains/domain?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "apexName": "Example Name",
  "createdAt": "123",
  "customEnvironmentId": "example_id",
  "gitBranch": "string",
  "name": "Example Name",
  "projectId": "example_id",
  "redirect": "string",
  "redirectStatusCode": "301",
  "updatedAt": "123",
  "verification": [
    {
      "domain": "string",
      "reason": "Customer requested refund",
      "type": "string",
      "value": "string"
    }
  ],
  "verified": "false"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired

The unique project identifier or the project name

domainstringRequired

The project domain name

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

apexNamestringRequired

createdAtnumberOptional

customEnvironmentIdstringOptional

gitBranchstringOptional

namestringRequired

projectIdstringRequired

redirectstringOptional

redirectStatusCodenumberOptional

updatedAtnumberOptional

verificationarrayOptional

A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete POST /projects/:idOrName/domains/:domain/verify to verify the domain. Possible challenges: - If verification.type = TXT the verification.domain will be checked for a TXT record matching verification.value.

verifiedbooleanRequired

true if the domain is verified for use with the project. If false it will not be used as an alias on this project until the challenge in verification is completed.

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Cross-link map: Get a project domain (/docs/rest-api/projects/get-a-project-domain)

From the Vercel docs graph (built 2026-10-07T05:48:34.144Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Retrieve project domains by project by id or name — GET /v9/projects/{idOrName}/domains — Retrieve the domains associated with a given project by passing either the project
List Project Domains by Apex Domain — GET /v1/domains/{domain}/project-domains — List all project domains associated with an apex domain owned by the authenti
Update a project domain — PATCH /v9/projects/{idOrName}/domains/{domain} — Update a project domain's configuration, including the name, git branch
Add a domain to a project — POST /v10/projects/{idOrName}/domains — Add a domain to the project by passing its domain name and by specifying the pro
Verify project domain — POST /v9/projects/{idOrName}/domains/{domain}/verify — Attempts to verify a project domain with \verified = false\\ by

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (2)

By site: vercel-docs (2)

Multi-tenant Reference — Reference for the Vercel domain API, error codes, troubleshooting, and FAQ for multi-tenant platforms.
Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v9/projects/{idOrName}/domains/{domain}

const response = await fetch('https://api.vercel.com/v9/projects/idOrName/domains/domain?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "apexName": "Example Name",
  "createdAt": "123",
  "customEnvironmentId": "example_id",
  "gitBranch": "string",
  "name": "Example Name",
  "projectId": "example_id",
  "redirect": "string",
  "redirectStatusCode": "301",
  "updatedAt": "123",
  "verification": [
    {
      "domain": "string",
      "reason": "Customer requested refund",
      "type": "string",
      "value": "string"
    }
  ],
  "verified": "false"
}

OpenAPI Specification