Maxim Logo
Folders/Contents

Get Folder Contents

Get the contents (entities) of a specific folder, identified by folderId or name+parentFolderId.

GET
/v1/folders/contents

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Query Parameters

workspaceIdRequiredstring

Unique identifier for the workspace

Minimum length: 1
folderIdstring

Unique identifier for the folder whose contents are to be fetched

namestring

Name of the folder whose contents are to be fetched

parentFolderIdstring

ID of the parent folder (used with name for uniqueness)

entityTypeRequiredstring
Value in: "WORKFLOW" | "PROMPT_CHAIN" | "DATASET" | "PROMPT" | "CONTEXT_SOURCE" | "PROMPT_COMPARISONS" | "LOG_REPOSITORY" | "PROMPT_TOOL"
limitnumber

Maximum number of records to return (max: 100)

Default: 20Maximum: 100
cursorstring

Cursor for pagination

curl -X GET "https://api.getmaxim.ai/v1/folders/contents?workspaceId=%3Cstring%3E&folderId=%3Cstring%3E&name=%3Cstring%3E&parentFolderId=%3Cstring%3E&entityType=WORKFLOW&limit=20&cursor=%3Cstring%3E" \
  -H "x-maxim-api-key: <token>"

Folder contents retrieved successfully

{
  "data": [
    null
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}