Skip to content
Docs

List all the domains

GEThttps://api.vercel.com/v5/domains
Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided.
https://api.vercel.com/v5/domains
const response = await fetch('https://api.vercel.com/v5/domains?limit=123&since=123&until=123&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
{
"domains": [
{
"boughtAt": "1613602938882",
"createdAt": "1613602938882",
"creator": {
"customerId": "example_id",
"email": "user@example.com",
"id": "icfg_1234567890",
"isDomainReseller": "false",
"username": "string"
},
"customNameservers": [],
"echMode": "auto",
"expiresAt": "123",
"id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
"intendedNameservers": [],
"name": "example.com",
"nameservers": [],
"renew": "true",
"serviceType": "zeit.world",
"teamId": "example_id",
"transferredAt": "1613602938882",
"transferStartedAt": "1613602938882",
"userId": "example_id",
"verified": "true"
}
],
"pagination": {
"count": "20",
"next": "1540095775951",
"prev": "1540095775951"
}
}
AuthorizationbearerToken

Default authentication mechanism

limitnumberOptional
Maximum number of domains to list from a request.
sincenumberOptional
Get domains created after this JavaScript timestamp.
untilnumberOptional
Get domains created before this JavaScript timestamp.
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.
200Successful response retrieving a list of domains.
domainsarrayRequired
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.
409Error
410Error