List Folder Entities

Beta

GET

List all folder entities within a specified folder.

Query parameters

entity_status"ACTIVE" or "ARCHIVED"Optional

Filter down to only those objects whose entities have a status matching the status specified.

ACTIVE - Active
ARCHIVED - Archived

Allowed values: ACTIVEARCHIVED

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

parent_folder_idstringRequired

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

This endpoint returns an object.

countintegerOptional

nextstringOptional

previousstringOptional

resultslist of objectsOptional

Built with

1	{
2	"count": 123,
3	"next": "http://api.example.org/accounts/?offset=400&limit=100",
4	"previous": "http://api.example.org/accounts/?offset=200&limit=100",
5	"results": [
6	{
7	"type": "TEST_SUITE",
8	"data": {
9	"id": "id",
10	"label": "label",
11	"created": "2024-01-15T09:30:00Z",
12	"modified": "2024-01-15T09:30:00Z",
13	"status": "ACTIVE"
14	},
15	"id": "results"
16	}
17	]
18	}

1	curl -G https://api.vellum.ai/v1/folder-entities \
2	-d parent_folder_id=parent_folder_id