Skip to main content
GET
/
v1
/
folders
Get Folders
curl --request GET \
  --url https://api.getmaxim.ai/v1/folders \
  --header 'x-maxim-api-key: <api-key>'
{
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "name": "<string>",
    "entityType": "WORKFLOW",
    "parentId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "config": "<unknown>",
    "type": "FOLDER"
  },
  "pagination": {
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

​
x-maxim-api-key
string
header
required

API key for authentication

Query Parameters

​
id
string

Unique identifier for the folder

​
name
string

Name of the folder

​
workspaceId
string
required

Unique identifier for the workspace

​
parentFolderId
string | null

ID of the parent folder to filter by

​
parentFolderName
string

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

​
entityType
enum<string>
required
Available options:
WORKFLOW,
PROMPT_CHAIN,
DATASET,
PROMPT,
CONTEXT_SOURCE,
PROMPT_COMPARISONS,
LOG_REPOSITORY,
PROMPT_TOOL
​
limit
number | null
default:20

Maximum number of records to return (max: 100)

Required range: x <= 100
​
cursor
string | null

Cursor for pagination

Response

Folders retrieved successfully

​
data
object
required

Single Folder object if fetching by id/name, array of Folders if listing.

  • object
  • object[]
​
pagination
object