Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

List vector IDs

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 also includes a pagination_token that you can use to get the next batch of IDs. When the response does not include a pagination_token, there are no more IDs to return.

For guidance and examples, see List record IDs.

Note: list is supported only for serverless indexes.

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: 2025-10"
curl
{
  "vectors": [
    { "id": "doc1#chunk1" },
    { "id": "doc1#chunk2" },
    { "id": "doc1#chunk3" }
  ],
  "pagination": {
    "next": "c2Vjb25kY2FsbA=="
  },
  "namespace": "example-namespace",
  "usage": {
    "readUnits": 1
  }
}

GET /vectors/list

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • prefix (query, string) — The vector IDs to fetch. Does not accept values containing spaces.
  • limit (query, integer) — Max number of IDs to return per page.
  • paginationToken (query, string) — Pagination token to continue a previous listing operation.
  • namespace (query, string) — The namespace to list vectors from. If not provided, the default namespace is used.
  • 200 — A successful response.
  • 400 — Bad request. The request body included invalid request parameters.
  • 4XX — An unexpected error response.
  • 5XX — An unexpected error response.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu