---
title: List Vectors
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Vectorize](https://developers.cloudflare.com/api/python/resources/vectorize)

[Indexes](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# List Vectors

vectorize.indexes.list\_vectors(strindex\_name, IndexListVectorsParams\*\*kwargs) -> [IndexListVectorsResponse](<https://developers.cloudflare.com/api/python/resources/vectorize#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)>)

GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/list

Returns a paginated list of vector identifiers from the specified index.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Vectorize Write``Vectorize Read`

##### ParametersExpand Collapse

account\_id: str

Identifier

maxLength32

[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20list_vectors%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

index\_name: str

[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20list_vectors%20%3E%20(params)%20default%20%3E%20(param)%20index_name%20%3E%20(schema)>)

count: Optional\[int]

Maximum number of vectors to return

maximum1000

minimum1

[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20list_vectors%20%3E%20(params)%20default%20%3E%20(param)%20count%20%3E%20(schema)>)

cursor: Optional\[str]

Cursor for pagination to get the next page of results

[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20list_vectors%20%3E%20(params)%20default%20%3E%20(param)%20cursor%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class IndexListVectorsResponse: …

</summary>

count: int

Number of vectors returned in this response

<a href="#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)%20%3E%20(property)%20count">Link to this property</a>

is\_truncated: bool

Whether there are more vectors available beyond this response

<a href="#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)%20%3E%20(property)%20isTruncated">Link to this property</a>

total\_count: int

Total number of vectors in the index

<a href="#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)%20%3E%20(property)%20totalCount">Link to this property</a>

<details>

<summary>

vectors: List\[Vector]

Array of vector items

</summary>

id: str

Identifier for a Vector

maxLength64

<a href="#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)%20%3E%20(property)%20vectors%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

</details>

<a href="#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)%20%3E%20(property)%20vectors">Link to this property</a>

cursor\_expiration\_timestamp: Optional\[datetime]

When the cursor expires as an ISO8601 string

formatdate-time

<a href="#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)%20%3E%20(property)%20cursorExpirationTimestamp">Link to this property</a>

next\_cursor: Optional\[str]

Cursor for the next page of results

<a href="#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)%20%3E%20(property)%20nextCursor">Link to this property</a>

</details>

[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)>)

### List Vectors

Python

HTTPTypeScriptPythonGoTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.vectorize.indexes.list_vectors(
    index_name="example-index",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(response.count)
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "count": 100,
    "isTruncated": true,
    "totalCount": 500,
    "vectors": [
      {
        "id": "some-vector-id-023e105f4ecef8ad9ca31a8372d0c353"
      }
    ],
    "cursorExpirationTimestamp": "2025-08-12T20:32:52.469144957Z",
    "nextCursor": "suUTaDY5PFUiRweVccnzyt9n75suNPbXHPshvCzue5mHjtj7Letjvzlza9eGj099"
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "count": 100,
    "isTruncated": true,
    "totalCount": 500,
    "vectors": [
      {
        "id": "some-vector-id-023e105f4ecef8ad9ca31a8372d0c353"
      }
    ],
    "cursorExpirationTimestamp": "2025-08-12T20:32:52.469144957Z",
    "nextCursor": "suUTaDY5PFUiRweVccnzyt9n75suNPbXHPshvCzue5mHjtj7Letjvzlza9eGj099"
  },
  "success": true
}
```