GetProjectDomainsRequest
April 11, 2026 ยท View on GitHub
Example Usage
import { GetProjectDomainsRequest } from "@vercel/sdk/models/getprojectdomainsop.js";
let value: GetProjectDomainsRequest = {
idOrName: "<value>",
customEnvironmentId: "env_123abc4567",
redirect: "example.com",
limit: 20,
since: 1609499532000,
until: 1612264332000,
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
slug: "my-team-url-slug",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
idOrName | string | :heavy_check_mark: | The unique project identifier or the project name | |
production | models.Production | :heavy_minus_sign: | Filters only production domains when set to true. | |
target | models.QueryParamTarget | :heavy_minus_sign: | Filters on the target of the domain. Can be either "production", "preview" | |
customEnvironmentId | string | :heavy_minus_sign: | The unique custom environment identifier within the project | env_123abc4567 |
gitBranch | string | :heavy_minus_sign: | Filters domains based on specific branch. | |
redirects | models.QueryParamRedirects | :heavy_minus_sign: | Excludes redirect project domains when "false". Includes redirect project domains when "true" (default). | |
redirect | string | :heavy_minus_sign: | Filters domains based on their redirect target. | example.com |
verified | models.Verified | :heavy_minus_sign: | Filters domains based on their verification status. | |
limit | number | :heavy_minus_sign: | Maximum number of domains to list from a request (max 100). | 20 |
since | number | :heavy_minus_sign: | Get domains created after this JavaScript timestamp. | 1609499532000 |
until | number | :heavy_minus_sign: | Get domains created before this JavaScript timestamp. | 1612264332000 |
order | models.Order | :heavy_minus_sign: | Domains sort order by createdAt | |
teamId | string | :heavy_minus_sign: | The Team identifier to perform the request on behalf of. | team_1a2b3c4d5e6f7g8h9i0j1k2l |
slug | string | :heavy_minus_sign: | The Team slug to perform the request on behalf of. | my-team-url-slug |