Returns up to 100 IDs at a time by default in sorted order (bitwise "C" collation). If the `limit` parameter is set, `list` returns up to that number of IDs instead. Whenever there are additional IDs to return, the response includes `pagination.next`, a token you pass as `paginationToken` to get the next batch of IDs. When the response has no `pagination`, there are no more IDs to return.

For guidance and examples, see [List record IDs](/guides/manage-data-list-record-ids).

**Note:** `list` is supported only for serverless indexes.

:::code-group
```shell curl
# 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 -X GET "https://$INDEX_HOST/vectors/list?namespace=example-namespace&prefix=doc1#&limit=3" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2026-07"
```
:::

`GET /vectors/list`

:::code-group
```json title="200"
{
  "vectors": [
    {
      "id": "document1#abb"
    },
    {
      "id": "document1#abc"
    }
  ],
  "pagination": {
    "next": "Tm90aGluZyB0byBzZWUgaGVyZQo="
  },
  "namespace": "example-namespace",
  "usage": {
    "readUnits": 5,
    "egressBytes": 1024
  }
}
```

```json title="400"
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
```

```json title="4XX"
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
```

```json title="5XX"
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
```
:::

#### Authorizations

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `Api-Key` | `string` | - |  |

An API Key is required to call Pinecone APIs. Get yours from the [console](https://app.pinecone.io/).

#### Headers

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `X-Pinecone-Api-Version` | `string` | `2026-07` | Required date-based version header |

#### Query Parameters

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `prefix?` | `string` | - | The ID prefix to match. Only records whose ID starts with this value are returned. Required string length: 0 - 512 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `limit?` | `integer` | `100` | Max number of IDs to return per page. Required range: 1 <= x <= 100 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `paginationToken?` | `string` | - | Pagination token to continue a previous listing operation. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `namespace?` | `string` | - | The namespace to list vectors from. If not provided, the default namespace is used. |

#### Response

`200` — A successful response.

The response for the `list` operation.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `vectors?` | `object[]` | - |  |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `id?` | `string` | - | Example: document1#abb |
:::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `pagination?` | `object` | - |  |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `next` | `string` | - | Example: Tm90aGluZyB0byBzZWUgaGVyZQo= |
:::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `namespace?` | `string` | - | The namespace that served the list: the request's namespace, or the alias's target namespace when the request named a namespace alias. Example: example-namespace |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `usage?` | `object` | - |  |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `readUnits?` | `integer` | - | The number of read units consumed by this operation. Example: 5 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `egressBytes?` | `integer` | - | The billed egress for this response, in bytes. Measured on the encoded response payload. Required range: 0 <= x. Example: 1024 |
:::

## Related pages

- [Search with a vector](./database-data-plane-query.md)
- [Search with text](./database-data-plane-search-records.md)
- [Upsert records](./database-data-plane-upsert.md)
- [Upsert text](./database-data-plane-upsert-records.md)
- [Fetch records](./database-data-plane-fetch.md)
- [Fetch records by metadata](./database-data-plane-fetch-by-metadata.md)
- [Update a record](./database-data-plane-update.md)
- [Delete records](./database-data-plane-delete.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.