> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.vellum.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vellum.ai/_mcp/server.

# List Folder Entities

GET https://api.vellum.ai/v1/folder-entities

List all folder entities within a specified folder.

Reference: https://docs.vellum.ai/developers/client-sdk/folders/list-folder-entities

## Authentication

- `X-API-KEY` header (required) — API Key authentication via header

## Request

### Query parameters

- `entity_status` (enum, optional) — Filter down to only those objects whose entities have a status matching the status specified. * `ACTIVE` - Active * `ARCHIVED` - Archived * `PENDING_DELETION` - Pending Deletion
  - Allowed values: `ACTIVE`, `ARCHIVED`, `PENDING_DELETION`
- `limit` (integer, optional) — Number of results to return per page.
- `offset` (integer, optional) — The initial index from which to return the results.
- `ordering` (string, optional) — Which field to use when ordering the results.
- `parent_folder_id` (string, required) — Filter down to only those entities whose parent folder has the specified ID. To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide a string representing the entity type of the root directory. Supported root directories include: - PROMPT_SANDBOX - WORKFLOW_SANDBOX - DOCUMENT_INDEX - TEST_SUITE

## Response

### 200

- `count` (integer, optional)
- `next` (string, optional, nullable)
- `previous` (string, optional, nullable)
- `results` (list of FolderEntity, optional)

## Types

### FolderEntity

### FolderEntityFolder

A slim representation of a Folder, as it exists within another Folder.

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `FOLDER`
- `data` (FolderEntityFolderData, required)

### FolderEntityPromptSandbox

A slim representation of a Prompt Sandbox, as it exists within a Folder.

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `PROMPT_SANDBOX`
- `data` (FolderEntityPromptSandboxData, required)

### FolderEntityWorkflowSandbox

A slim representation of a Workflow Sandbox, as it exists within a Folder.

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `WORKFLOW_SANDBOX`
- `data` (FolderEntityWorkflowSandboxData, required)

### FolderEntityDocumentIndex

A slim representation of a Document Index, as it exists within a Folder.

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `DOCUMENT_INDEX`
- `data` (FolderEntityDocumentIndexData, required)

### FolderEntityTestSuite

A slim representation of a Test Suite, as it exists within a Folder.

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `TEST_SUITE`
- `data` (FolderEntityTestSuiteData, required)

### FolderEntityDataset

A slim representation of a Dataset, as it exists within a Folder.

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `DATASET`
- `data` (FolderEntityDatasetData, required)

### FolderEntityFolderData

- `id` (string, required)
- `label` (string, required)
- `created` (string, required)
- `modified` (string, required)
- `has_contents` (boolean, required)

### FolderEntityPromptSandboxData

- `id` (string, required)
- `label` (string, required)
- `created` (string, required)
- `modified` (string, required)
- `status` (enum, required) — * `ACTIVE` - Active * `ARCHIVED` - Archived * `PENDING_DELETION` - Pending Deletion
  - Allowed values: `ACTIVE`, `ARCHIVED`, `PENDING_DELETION`
- `description` (string, optional, nullable)
- `last_deployed_on` (string, optional, nullable)

### FolderEntityWorkflowSandboxData

- `id` (string, required)
- `label` (string, required)
- `created` (string, required)
- `modified` (string, required)
- `status` (enum, required) — * `ACTIVE` - Active * `ARCHIVED` - Archived * `PENDING_DELETION` - Pending Deletion
  - Allowed values: `ACTIVE`, `ARCHIVED`, `PENDING_DELETION`
- `display_data` (WorkflowSandboxDisplayData, required, nullable) — Information used to display this Workflow Sandbox.
- `description` (string, optional, nullable)
- `last_deployed_on` (string, optional, nullable)

### FolderEntityDocumentIndexData

- `id` (string, required)
- `label` (string, required)
- `created` (string, required)
- `modified` (string, required)
- `status` (enum, required) — * `ACTIVE` - Active * `ARCHIVED` - Archived * `PENDING_DELETION` - Pending Deletion
  - Allowed values: `ACTIVE`, `ARCHIVED`, `PENDING_DELETION`
- `indexing_config` (DocumentIndexIndexingConfig, required)

### FolderEntityTestSuiteData

- `id` (string, required)
- `label` (string, required)
- `created` (string, required)
- `modified` (string, required)
- `status` (enum, required) — * `ACTIVE` - Active * `ARCHIVED` - Archived * `PENDING_DELETION` - Pending Deletion
  - Allowed values: `ACTIVE`, `ARCHIVED`, `PENDING_DELETION`

### FolderEntityDatasetData

- `id` (string, required)
- `label` (string, required)
- `name` (string, required)
- `created` (string, required)
- `modified` (string, required)
- `description` (string, optional, nullable)

### WorkflowSandboxDisplayData

Information used to display this Workflow Sandbox.

- `icon` (WorkflowDisplayIcon, optional, nullable) — The icon associated with this Workflow Sandbox.

### DocumentIndexIndexingConfig

- `vectorizer` (IndexingConfigVectorizer, required)
- `chunking` (DocumentIndexChunking, optional, nullable)

### WorkflowDisplayIcon

Icon to be used alongside a Workflow

- `src` (string, optional, nullable)
- `color` (string, optional, nullable)

### IndexingConfigVectorizer

### DocumentIndexChunking

### OpenAIVectorizerTextEmbedding3Small

OpenAI vectorizer for text-embedding-3-small.

- `config` (OpenAIVectorizerConfig, required) — Configuration for using an OpenAI vectorizer.
- `model_name` (enum, required)
  - Allowed values: `text-embedding-3-small`

### OpenAIVectorizerTextEmbedding3Large

OpenAI vectorizer for text-embedding-3-large.

- `config` (OpenAIVectorizerConfig, required) — Configuration for using an OpenAI vectorizer.
- `model_name` (enum, required)
  - Allowed values: `text-embedding-3-large`

### OpenAIVectorizerTextEmbeddingAda002

OpenAI vectorizer for text-embedding-ada-002.

- `config` (OpenAIVectorizerConfig, required) — Configuration for using an OpenAI vectorizer.
- `model_name` (enum, required)
  - Allowed values: `text-embedding-ada-002`

### BasicVectorizerIntfloatMultilingualE5Large

Basic vectorizer for intfloat/multilingual-e5-large.

- `model_name` (enum, required)
  - Allowed values: `intfloat/multilingual-e5-large`
- `config` (map from string to any, optional, nullable)

### BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.

- `model_name` (enum, required)
  - Allowed values: `sentence-transformers/multi-qa-mpnet-base-cos-v1`
- `config` (map from string to any, optional, nullable)

### BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.

- `model_name` (enum, required)
  - Allowed values: `sentence-transformers/multi-qa-mpnet-base-dot-v1`
- `config` (map from string to any, optional, nullable)

### HkunlpInstructorXlVectorizer

Vectorizer for hkunlp/instructor-xl.

- `model_name` (enum, required)
  - Allowed values: `hkunlp/instructor-xl`
- `config` (InstructorVectorizerConfig, required) — Configuration for using an Instructor vectorizer.

### GoogleVertexAIVectorizerTextEmbedding004

- `model_name` (enum, required)
  - Allowed values: `text-embedding-004`
- `config` (GoogleVertexAIVectorizerConfig, required)

### GoogleVertexAIVectorizerTextMultilingualEmbedding002

- `model_name` (enum, required)
  - Allowed values: `text-multilingual-embedding-002`
- `config` (GoogleVertexAIVectorizerConfig, required)

### GoogleVertexAIVectorizerGeminiEmbedding001

- `model_name` (enum, required)
  - Allowed values: `gemini-embedding-001`
- `config` (GoogleVertexAIVectorizerConfig, required)

### FastEmbedVectorizerBAAIBgeSmallEnV15

FastEmbed vectorizer for BAAI/bge-small-en-v1.5.

- `model_name` (enum, required)
  - Allowed values: `BAAI/bge-small-en-v1.5`

### PrivateVectorizer

Serializer for private vectorizer.

- `model_name` (enum, required)
  - Allowed values: `private-vectorizer`

### ReductoChunking

Reducto chunking

- `chunker_name` (enum, required)
  - Allowed values: `reducto-chunker`
- `chunker_config` (ReductoChunkerConfig, optional) — Configuration for Reducto chunking

### SentenceChunking

Sentence chunking

- `chunker_name` (enum, required)
  - Allowed values: `sentence-chunker`
- `chunker_config` (SentenceChunkerConfig, optional) — Configuration for sentence chunking

### TokenOverlappingWindowChunking

Token overlapping window chunking

- `chunker_name` (enum, required)
  - Allowed values: `token-overlapping-window-chunker`
- `chunker_config` (TokenOverlappingWindowChunkerConfig, optional) — Configuration for token overlapping window chunking

### DelimiterChunking

- `chunker_name` (enum, required)
  - Allowed values: `delimiter-chunker`
- `chunker_config` (DelimiterChunkerConfig, optional)

### OpenAIVectorizerConfig

Configuration for using an OpenAI vectorizer.

- `add_openai_api_key` (boolean, optional) — * `True` - True

### InstructorVectorizerConfig

Configuration for using an Instructor vectorizer.

- `instruction_domain` (string, required)
- `instruction_query_text_type` (string, required)
- `instruction_document_text_type` (string, required)

### GoogleVertexAIVectorizerConfig

- `project_id` (string, required)
- `region` (string, required)

### ReductoChunkerConfig

Configuration for Reducto chunking

- `character_limit` (integer, optional, default: 1000)

### SentenceChunkerConfig

Configuration for sentence chunking

- `character_limit` (integer, optional, default: 1000)
- `min_overlap_ratio` (double, optional, default: 0.5)

### TokenOverlappingWindowChunkerConfig

Configuration for token overlapping window chunking

- `token_limit` (integer, optional, default: 250)
- `overlap_ratio` (double, optional, default: 0.5)

### DelimiterChunkerConfig

- `delimiter` (string, optional, default: \n\n)
- `is_regex` (boolean, optional, default: false)

## Examples

**Response**

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "string",
      "type": "FOLDER",
      "data": {
        "id": "string",
        "label": "string",
        "created": "2024-01-15T09:30:00Z",
        "modified": "2024-01-15T09:30:00Z",
        "has_contents": true
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.vellum.ai/v1/folder-entities"

querystring = {"parent_folder_id":"parent_folder_id"}

headers = {"X-API-KEY": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```typescript
import { VellumClient } from "vellum-ai";

const client = new VellumClient({ apiKey: "YOUR_API_KEY", apiVersion: "YOUR_API_VERSION" });
await client.folderEntities.list({
    parentFolderId: "parent_folder_id"
});

```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vellum.ai/v1/folder-entities?parent_folder_id=parent_folder_id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.vellum.ai/v1/folder-entities?parent_folder_id=parent_folder_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.vellum.ai/v1/folder-entities?parent_folder_id=parent_folder_id")
  .header("X-API-KEY", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.vellum.ai/v1/folder-entities?parent_folder_id=parent_folder_id', [
  'headers' => [
    'X-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.vellum.ai/v1/folder-entities?parent_folder_id=parent_folder_id");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-KEY", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-KEY": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.vellum.ai/v1/folder-entities?parent_folder_id=parent_folder_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```