Skip to main content
GET
/
data
/
projects
/
{projectId}
/
queries
/
folders
/
{folderId}
Read Query Folder
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/folders/{folderId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Reports",
  "path": "/Reports",
  "parentId": null,
  "createdAt": "2025-01-15T10:30:00Z",
  "folders": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Monthly",
      "path": "/Reports/Monthly",
      "parentId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:31:00Z"
    }
  ],
  "queries": [
    {
      "id": "709922802836177297",
      "displayName": "Revenue Report",
      "name": "revenuereport",
      "inputQuery": "SELECT * FROM revenue",
      "path": "/Reports",
      "folderId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the Project

​
folderId
string
required

ID of the Query Folder

Response

Folder read successfully

A folder with its direct child folders and queries

​
id
string

Unique identifier of the folder (UUID)

​
name
string

Display name of the folder

​
path
string

Full path of the folder in the hierarchy

​
parentId
string

ID of the parent folder, null if root-level

​
createdAt
string

Timestamp when the folder was created (ISO 8601)

​
folders
object[]

Direct child folders

​
queries
object[]

Queries contained in this folder