Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Fetch records by metadata

Look up and return records by metadata from a single namespace. The returned records include the vector data and metadata.

For guidance and examples, see Fetch data.

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 POST "https://$INDEX_HOST/vectors/fetch_by_metadata" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Pinecone-Api-Version: 2026-07" \
  -d '{
    "namespace": "__default__",
    "filter": {"genre": {"$eq": "Action/Adventure"}},
    "limit": 2
  }'

POST /vectors/fetch_by_metadata

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • namespace (body, string) — The namespace to fetch records from.
  • filter (body, object, required) — Metadata filter expression to select vectors. See Understanding metadata.
  • limit (body, integer) — The maximum number of records to return per page. Defaults to 100.
  • paginationToken (body, string) — Pagination token to continue a previous listing operation.
  • 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.
Suggest an edit

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

Export
Documentation menu