GET /v9/projects/{idOrName}/domains
Retrieve the domains associated with a given project by passing either the project id or name in the URL.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
idOrName |
Yes |
The unique project identifier or the project name |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
teamId |
String | No |
The Team identifier to perform the request on behalf of. |
gitBranch |
String | No |
Filters domains based on specific branch. |
since |
Number | No |
Get domains created after this JavaScript timestamp. |
redirect |
String | No |
Filters domains based on their redirect target. |
redirects |
String | No |
Excludes redirect project domains when "false". Includes redirect project domains when "true" (default). Possible values:
Default value: "true" |
production |
String | No |
Filters only production domains when set to Possible values:
Default value: "false" |
order |
String | No |
Domains sort order by createdAt Possible values:
Default value: "DESC" |
limit |
Number | No |
Maximum number of domains to list from a request (max 100). |
slug |
String | No |
The Team slug to perform the request on behalf of. |
customEnvironmentId |
String | No |
The unique custom environment identifier within the project |
until |
Number | No |
Get domains created before this JavaScript timestamp. |
target |
String | No |
Filters on the target of the domain. Can be either "production", "preview" Possible values:
|
verified |
String | No |
Filters domains based on their verification status. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.