Client SDKFoldersBeta

List Folder Entities

List all folder entities within a specified folder.

Headers

X_API_KEYstringRequired

Query parameters

entity_statusenumOptional

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

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values:
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

countintegerOptional
nextstringOptionalformat: "uri"
previousstringOptionalformat: "uri"
resultslist of objectsOptional