> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinecone.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List namespace aliases

> List the namespace aliases in a serverless index, ordered by name. Filter by name prefix or by target namespace.

Up to 100 aliases are returned per page; set `limit` to return fewer. When more remain, the response includes `pagination.next`; pass it as `paginationToken` to get the next page.

For guidance and examples, see [Manage namespace aliases](https://docs.pinecone.io/guides/manage-data/namespace-aliases/manage-aliases).

<RequestExample>
  ```bash curl theme={null}
  # To get the unique host for an index,
  # see https://docs.pinecone.io/guides/manage-data/target-an-index
  PINECONE_API_KEY="YOUR_API_KEY"
  INDEX_HOST="INDEX_HOST"

  curl "https://$INDEX_HOST/namespace-aliases" \
      -H "Api-Key: $PINECONE_API_KEY" \
      -H "X-Pinecone-Api-Version: 2026-07"
  ```
</RequestExample>


## OpenAPI

````yaml https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespace-aliases
openapi: 3.0.3
info:
  title: Pinecone Data Plane API
  description: >-
    Pinecone is a vector database that makes it easy to search and retrieve
    billions of high-dimensional vectors.
  contact:
    name: Pinecone Support
    url: https://support.pinecone.io
    email: support@pinecone.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 2026-07
servers:
  - url: https://{index_host}
    variables:
      index_host:
        default: unknown
        description: host of the index
security:
  - ApiKeyAuth: []
tags:
  - name: Vector Operations
  - name: Bulk Operations
  - name: Namespace Operations
  - name: Namespace Alias Operations
  - name: Document Operations
    description: >-
      Operations on documents in an index created with a document schema — one
      that declares at least one full-text-searchable string field or a
      `dense_vector` / `sparse_vector` field under a name other than the
      reserved `_values` / `_sparse_values`. Metadata fields alone do not make a
      document schema. Indexes served by the vectors API — created from
      `dimension`/`metric` on an earlier API version, or from a schema holding
      only the reserved vector fields and metadata — and indexes served by the
      records API — created with an integrated embedding model, whose schema
      holds a single `semantic_text` field — reject every document operation
      with `400` and name the API to use instead. A document index accepts only
      the document operations; the vector data operations (upsert, query, fetch,
      update, delete, list) reject it, while index stats and the namespace
      operations remain available.
externalDocs:
  description: More Pinecone.io API docs
  url: https://docs.pinecone.io/introduction
paths:
  /namespace-aliases:
    get:
      tags:
        - Namespace Alias Operations
      summary: List namespace aliases
      description: >-
        List the namespace aliases in a serverless index, ordered by name.
        Filter by name prefix or by target namespace.


        Up to 100 aliases are returned per page; set `limit` to return fewer.
        When more remain, the response includes `pagination.next`; pass it as
        `paginationToken` to get the next page.


        For guidance and examples, see [Manage namespace
        aliases](https://docs.pinecone.io/guides/manage-data/namespace-aliases/manage-aliases).
      operationId: listNamespaceAliases
      parameters:
        - in: header
          name: X-Pinecone-Api-Version
          description: Required date-based version header
          required: true
          schema:
            default: 2026-07
            type: string
          style: simple
        - in: query
          name: limit
          description: Max number of aliases to return per page. Defaults to 100.
          schema:
            default: 100
            type: integer
            format: int32
            minimum: 1
            maximum: 100
          example: 10
          style: form
        - in: query
          name: paginationToken
          description: >-
            Pagination token to continue a previous listing operation. Filters
            are carried by the token; if they are repeated in the request, they
            must match.
          schema:
            type: string
          style: form
        - in: query
          name: prefix
          description: >-
            Prefix of the aliases to list. Acts as a filter to return only
            aliases whose name starts with this prefix.
          schema:
            type: string
            pattern: ^[\x01-\x7F]*$
            maxLength: 512
          example: dataset
          style: form
        - in: query
          name: target_namespace
          description: >-
            Return only aliases that resolve to this namespace. Use
            `__default__` for the default namespace. Aliases cannot be targets,
            so an alias name here matches nothing. Combines with `prefix`.
          schema:
            type: string
            pattern: ^[\x01-\x7F]+$
            minLength: 1
            maxLength: 512
          example: dataset_v1
          style: form
      responses:
        '200':
          description: A successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNamespaceAliasesResponse'
        '400':
          description: >-
            Bad request. The `reason` field of the error's `details` entry
            identifies the cause: `LIST_INVALID_LIMIT` (`limit` is out of
            range), `INVALID_PAGINATION_TOKEN` (the pagination token is
            malformed or from another endpoint),
            `LIST_INVALID_TOKEN_WITH_PREFIX` or `LIST_INVALID_TOKEN_WITH_TARGET`
            (a repeated filter disagrees with the token),
            `LIST_INVALID_TOKEN_WITH_NEW_PREFIX` or
            `LIST_INVALID_TOKEN_WITH_NEW_TARGET` (a filter was added
            mid-listing), `TARGET_FILTER_EMPTY` (`target_namespace` is present
            but empty), `PREFIX_TOO_LONG`, `PREFIX_MUST_BE_ASCII`, or
            `PREFIX_MUST_NOT_CONTAIN_NULL_CHARACTER` (the `prefix` is invalid),
            or `API_VERSION_TOO_OLD` (the API version is too old). An unknown
            query parameter is also rejected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
        '401':
          description: 'Unauthorized. Possible causes: missing or invalid API key.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UnauthorizedMessage'
        4XX:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
        5XX:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
components:
  schemas:
    ListNamespaceAliasesResponse:
      type: object
      properties:
        namespace_aliases:
          description: The aliases in this index that match the request, ordered by name.
          type: array
          items:
            $ref: '#/components/schemas/NamespaceAliasDescription'
        pagination:
          $ref: '#/components/schemas/Pagination'
        total_count:
          example: 3
          description: >-
            The total number of aliases in the index matching the request
            filters. May change between pages under concurrent modifications.
          type: integer
          format: int32
      required:
        - total_count
    rpcStatus:
      description: >-
        The error response shape returned by the vector and bulk operations.
        Requests rejected by the authentication and rate-limiting layer before
        they reach the service (`401`, and the `400`, `403`, and `429` it
        produces) return a plain-text body instead.
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    UnauthorizedMessage:
      example: Unauthorized
      description: >-
        The plain-text body of a `401` response. Authentication failures are
        rejected before the request reaches the index, so they carry the message
        `Unauthorized` rather than an error object.
      type: string
    NamespaceAliasDescription:
      description: A description of a namespace alias and the namespace it resolves to.
      type: object
      properties:
        name:
          example: dataset
          description: The name of the alias. Immutable after creation.
          type: string
        target_namespace:
          example: dataset_v1
          description: >-
            The namespace the alias resolves to. Changed only by repointing the
            alias. The default namespace is represented as `__default__`.
          type: string
        created_at:
          example: '2026-09-01T12:00:00.000Z'
          description: The time the alias was created.
          type: string
          format: date-time
        updated_at:
          example: '2026-09-01T12:00:00.000Z'
          description: >-
            The time the alias was last repointed. Advances on every repoint,
            including a repoint to the alias's current target; equals
            `created_at` until the first repoint.
          type: string
          format: date-time
      required:
        - name
        - target_namespace
        - created_at
        - updated_at
    Pagination:
      type: object
      properties:
        next:
          example: Tm90aGluZyB0byBzZWUgaGVyZQo=
          type: string
      required:
        - next
    protobufAny:
      type: object
      properties:
        typeUrl:
          type: string
        value:
          type: string
          format: byte
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Api-Key
      description: >-
        An API Key is required to call Pinecone APIs. Get yours from the
        [console](https://app.pinecone.io/).

````