Skip to main content
GET
/
v1
/
folders
/
contents
Get Folder Contents
curl --request GET \
  --url https://api.getmaxim.ai/v1/folders/contents \
  --header 'x-maxim-api-key: <api-key>'
import requests

url = "https://api.getmaxim.ai/v1/folders/contents"

headers = {"x-maxim-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-maxim-api-key': '<api-key>'}};

fetch('https://api.getmaxim.ai/v1/folders/contents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmaxim.ai/v1/folders/contents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-maxim-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.getmaxim.ai/v1/folders/contents"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-maxim-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.getmaxim.ai/v1/folders/contents")
.header("x-maxim-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/folders/contents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-maxim-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    null
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Query Parameters

workspaceId
string
required

Unique identifier for the workspace

Minimum string length: 1
folderId
string

Unique identifier for the folder whose contents are to be fetched

name
string

Name of the folder whose contents are to be fetched

parentFolderId
string | null

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

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

Maximum number of records to return (max: 100)

Required range: x <= 100
cursor
string | null

Cursor for pagination

Response

Folder contents retrieved successfully

data
null[]
required

Array of entities within the folder.

pagination
object
required