List record 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 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.

Note: list is supported only for serverless indexes.

# 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

• X-Pinecone-Api-Version (header, string, required) — Required date-based version header
• prefix (query, string) — The ID prefix to match. Only records whose ID starts with this value are returned.
• 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.
• 401 — Unauthorized. Possible causes: missing or invalid API key.
• 4XX — An unexpected error response.
• 5XX — An unexpected error response.