List record IDs
List the IDs of records in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.
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
{
"vectors": [
{
"id": "document1#abb"
},
{
"id": "document1#abc"
}
],
"pagination": {
"next": "Tm90aGluZyB0byBzZWUgaGVyZQo="
},
"namespace": "example-namespace",
"usage": {
"readUnits": 5,
"egressBytes": 1024
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "<string>"
}
]
}Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
Query Parameters
Section titled “Query Parameters”prefix?stringThe ID prefix to match. Only records whose ID starts with this value are returned.
Required string length: 0 - 512
limit?integerMax number of IDs to return per page.
Required range: 1 <= x <= 100
paginationToken?stringPagination token to continue a previous listing operation.
namespace?stringThe namespace to list vectors from. If not provided, the default namespace is used.
Response
Section titled “Response”200 — A successful response.
The response for the list operation.
vectors?object[]Show child attributes
id?stringExample: document1#abb
pagination?objectShow child attributes
nextstringrequiredExample: Tm90aGluZyB0byBzZWUgaGVyZQo=
namespace?stringThe 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
usage?objectShow child attributes
readUnits?integerThe number of read units consumed by this operation.
Example: 5
egressBytes?integerThe billed egress for this response, in bytes. Measured on the encoded response payload.
Required range: 0 <= x. Example: 1024