projects

Retrieve project domains by project by id or name

Changed on

Retrieve the domains associated with a given project by passing either the project id or name in the URL.

get/v9/projects/{idOrName}/domains

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v9/projects/{idOrName}/domains
  • Auth: HTTP bearer

Path parameters

idOrNamestring required

The unique project identifier or the project name

Query parameters

production'true' | 'false'

Filters only production domains when set to true.

target'production' | 'preview'

Filters on the target of the domain. Can be either "production", "preview"

customEnvironmentIdstring

The unique custom environment identifier within the project

Example:env_123abc4567
gitBranchstring

Filters domains based on specific branch.

redirects'true' | 'false'

Excludes redirect project domains when "false". Includes redirect project domains when "true" (default).

redirectstring

Filters domains based on their redirect target.

Example:example.com
verified'true' | 'false'

Filters domains based on their verification status.

limitnumber

Maximum number of domains to list from a request (max 100).

Example:20
sincenumber

Get domains created after this JavaScript timestamp.

Example:1609499532000
untilnumber

Get domains created before this JavaScript timestamp.

Example:1612264332000
order'ASC' | 'DESC'

Domains sort order by createdAt

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

OR

Example response

{
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Changes