Get Folders

Get folder details. If id or name is provided, returns a single folder object. Otherwise, lists sub-folders under the parentFolderId (or root).

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Query Parameters

idstring

Unique identifier for the folder

namestring

Name of the folder

workspaceIdRequiredstring

Unique identifier for the workspace

parentFolderIdstring

ID of the parent folder to filter by

parentFolderNamestring

Name of the parent folder to filter by (alternative to parentFolderId)

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?id=%3Cstring%3E&name=%3Cstring%3E&workspaceId=%3Cstring%3E&parentFolderId=%3Cstring%3E&parentFolderName=%3Cstring%3E&entityType=WORKFLOW&limit=20&cursor=%3Cstring%3E" \
  -H "x-maxim-api-key: <token>"

Folders retrieved successfully

{
  "data": {
    "id": "string",
    "workspaceId": "string",
    "name": "string",
    "entityType": "WORKFLOW",
    "parentId": "string",
    "config": null,
    "createdAt": "string",
    "updatedAt": "string",
    "type": "FOLDER"
  },
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}

Authorization

Query Parameters

Response

TypeScript