Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

List imports

List all recent and ongoing import operations.

By default, list_imports returns up to 100 imports per page. If the limit parameter is set, list returns up to that number of imports 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 imports. When the response has no pagination, there are no more imports to return.

For guidance and examples, see Import 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 GET "https://$INDEX_HOST/bulk/imports?paginationToken=Tm90aGluZyB0byBzZWUgaGVyZQo" \
  -H 'Api-Key: $PINECONE_API_KEY' \
  -H 'X-Pinecone-Api-Version: 2026-07'

GET /bulk/imports

200
{
  "data": [
    {
      "id": "101",
      "uri": "<string>",
      "status": "Pending",
      "createdAt": "<string>",
      "finishedAt": "<string>",
      "percentComplete": 42.2,
      "recordsImported": 1000000,
      "error": "<string>",
      "validationResult": {
        "importSuccesses": 999990,
        "importErrors": 10
      }
    }
  ],
  "pagination": {
    "next": "Tm90aGluZyB0byBzZWUgaGVyZQo="
  }
}
400
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
4XX
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
5XX
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
Api-Keystringrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2026-07
limit?integer

Max number of operations to return per page.

Required range: 1 <= x <= 100

Typeinteger
Default100
paginationToken?string

Pagination token to continue a previous listing operation.

Typestring

200 — A list of import operations

The response for the list_imports operation.

data?object[]
Show child attributes
idstringrequired

Unique identifier for the import operation.

Required string length: 1 - 1000. Example: 101

Typestring
uristringrequired

The URI from where the data is imported.

Typestring
statusstringrequired

The status of the operation. Possible values: Pending, InProgress, Failed, Completed, or Cancelled.

Example: Pending

Typestring
createdAtstringrequired

The start time of the import operation.

Typestring
finishedAt?string

The end time of the import operation.

Typestring
percentCompletenumberrequired

The progress made by the operation, as a percentage.

Required range: 0 <= x <= 100. Example: 42.2

Typenumber
recordsImportedintegerrequired

The number of records successfully imported.

Required range: 0 <= x. Example: 1000000

Typeinteger
error?string

The error message if the import process failed.

Typestring
validationResult?object

The result of the validation run performed on the import data. Present only once validation has run.

Typeobject
Show child attributes
importSuccesses?integer

The number of records that passed validation.

Required range: 0 <= x. Example: 999990

Typeinteger
importErrors?integer

The number of records that failed validation.

Required range: 0 <= x. Example: 10

Typeinteger
pagination?object
Show child attributes
nextstringrequired

Example: Tm90aGluZyB0byBzZWUgaGVyZQo=

Typestring
Suggest an edit

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

Export
Documentation menu