List aliases

APIs & SDKs

List aliases

GEThttps://api.vercel.com/v4/aliases

Retrieves a list of aliases for the authenticated User or Team. When domain is provided, only aliases for that domain will be returned. When projectId is provided, it will only return the given project aliases.

https://api.vercel.com/v4/aliases

const response = await fetch('https://api.vercel.com/v4/aliases?domain=value&from=123&limit=123&projectId=string&since=123&until=123&rollbackDeploymentId=string&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

{
  "aliases": [
    {
      "alias": "my-alias.vercel.app",
      "created": "2017-04-26T23:00:34.232Z",
      "createdAt": "1540095775941",
      "creator": {
        "uid": "96SnxkFiMyVKsK3pnoHfx3Hz",
        "email": "john-doe@gmail.com",
        "username": "john-doe"
      },
      "deletedAt": "1540095775941",
      "deployment": {
        "id": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
        "url": "my-instant-deployment-3ij3cxz9qr.now.sh",
        "meta": "[object Object]"
      },
      "deploymentId": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
      "projectId": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
      "redirect": "string",
      "redirectStatusCode": "301",
      "uid": "example_id",
      "updatedAt": "1540095775941",
      "protectionBypass": "value",
      "microfrontends": {
        "defaultApp": {
          "projectId": "example_id"
        },
        "applications": [
          {
            "fallbackHost": "string",
            "projectId": "example_id"
          }
        ]
      }
    }
  ],
  "pagination": {
    "count": "20",
    "next": "1540095775951",
    "prev": "1540095775951"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

domainanyOptional

Get only aliases of the given domain name

fromnumberOptionalDeprecated

Get only aliases created after the provided timestamp

limitnumberOptional

Maximum number of aliases to list from a request

projectIdstringOptional

Filter aliases from the given projectId

sincenumberOptional

Get aliases created after this JavaScript timestamp

untilnumberOptional

Get aliases created before this JavaScript timestamp

rollbackDeploymentIdstringOptional

Get aliases that would be rolled back for the given deployment

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200The paginated list of aliases

aliasesarrayRequired

paginationobjectRequired

This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.

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: List aliases (/docs/rest-api/aliases/list-aliases)

From the Vercel docs graph (built 2026-09-09T06:26:35.535Z), 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

Get an Alias — GET /v4/aliases/{idOrAlias} — Retrieves an Alias for the given host name or alias ID.
List Deployment Aliases — GET /v2/deployments/{id}/aliases — Retrieves all Aliases for the Deployment with the given ID. The authenticated user or
Gets a list of aliases with status for the current promote — GET /v1/projects/{projectId}/promote/aliases — Get a list of aliases related to the last promote request with their mapp
Assign an Alias — POST /v2/deployments/{id}/aliases — Creates a new alias for the deployment resolved from the given deployment or alias I
Delete an Alias — DELETE /v2/aliases/{aliasId} — Delete an Alias with the specified ID.

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 (1)

By site: vercel-docs (1)

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

https://api.vercel.com/v4/aliases

const response = await fetch('https://api.vercel.com/v4/aliases?domain=value&from=123&limit=123&projectId=string&since=123&until=123&rollbackDeploymentId=string&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

{
  "aliases": [
    {
      "alias": "my-alias.vercel.app",
      "created": "2017-04-26T23:00:34.232Z",
      "createdAt": "1540095775941",
      "creator": {
        "uid": "96SnxkFiMyVKsK3pnoHfx3Hz",
        "email": "john-doe@gmail.com",
        "username": "john-doe"
      },
      "deletedAt": "1540095775941",
      "deployment": {
        "id": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
        "url": "my-instant-deployment-3ij3cxz9qr.now.sh",
        "meta": "[object Object]"
      },
      "deploymentId": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
      "projectId": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
      "redirect": "string",
      "redirectStatusCode": "301",
      "uid": "example_id",
      "updatedAt": "1540095775941",
      "protectionBypass": "value",
      "microfrontends": {
        "defaultApp": {
          "projectId": "example_id"
        },
        "applications": [
          {
            "fallbackHost": "string",
            "projectId": "example_id"
          }
        ]
      }
    }
  ],
  "pagination": {
    "count": "20",
    "next": "1540095775951",
    "prev": "1540095775951"
  }
}

OpenAPI Specification

Build with AI

Deploy & scale

Operate & protect

Resources

Authentication

Query parameters

Response

Errors

Cross-link map: List aliases (/docs/rest-api/aliases/list-aliases)

Semantically closest pages

This page links to (1)

Pages that link here (1)

Cross-link map: List aliases (/docs/rest-api/aliases/list-aliases)

Semantically closest pages

This page links to (1)

Pages that link here (1)