> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peaka.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Read Query Folder
> Returns a single folder by its ID, including its direct child folders and the queries it contains.
## OpenAPI
````yaml get /data/projects/{projectId}/queries/folders/{folderId}
openapi: 3.0.1
info:
title: Peaka Gateway API
description: Peaka Gateway API Documentation
version: '1.0'
servers:
- url: https://partner.peaka.studio/api/v1
description: Default Server URL (US Zone)
- url: https://partner.eu.peaka.studio/api/v1
description: EU Zone
security:
- bearerAuth: []
paths:
/data/projects/{projectId}/queries/folders/{folderId}:
get:
tags:
- Data -- Query Folders
summary: Read Query Folder
description: >-
Returns a single folder by its ID, including its direct child folders
and the queries it contains.
operationId: readQueryFolder
parameters:
- name: projectId
in: path
description: ID of the Project
required: true
schema:
type: string
example: mtKDhe1U
- name: folderId
in: path
description: ID of the Query Folder
required: true
schema:
type: string
example: 550e8400-e29b-41d4-a716-446655440000
responses:
'200':
description: Folder read successfully
content:
application/json:
schema:
$ref: '#/components/schemas/QueryFolderWithContentsResponse'
example:
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
'404':
description: Folder not found
content:
'*/*':
schema:
$ref: '#/components/schemas/QueryFolderWithContentsResponse'
components:
schemas:
QueryFolderWithContentsResponse:
type: object
properties:
id:
type: string
description: Unique identifier of the folder (UUID)
name:
type: string
description: Display name of the folder
path:
type: string
description: Full path of the folder in the hierarchy
parentId:
type: string
description: ID of the parent folder, null if root-level
createdAt:
type: string
description: Timestamp when the folder was created (ISO 8601)
folders:
type: array
description: Direct child folders
items:
$ref: '#/components/schemas/QueryFolderItem'
queries:
type: array
description: Queries contained in this folder
items:
$ref: '#/components/schemas/Query'
description: A folder with its direct child folders and queries
QueryFolderItem:
type: object
properties:
id:
type: string
description: Unique identifier of the folder (UUID)
example: 550e8400-e29b-41d4-a716-446655440000
name:
type: string
description: Display name of the folder
example: Monthly Reports
path:
type: string
description: Full path of the folder in the hierarchy
example: /reports/monthly
parentId:
type: string
description: ID of the parent folder, null if root-level
example: 550e8400-e29b-41d4-a716-446655440001
createdAt:
type: string
description: Timestamp when the folder was created (ISO 8601)
example: '2025-01-15T10:30:00Z'
description: Represents a query folder
Query:
type: object
properties:
id:
type: string
description: The ID of the query.
displayName:
type: string
description: The display name of the query.
name:
type: string
description: >-
The name of the query used in SQL, e.g. SELECT * FROM
"peaka"."query"."". For a MATERIALIZED query the materialized
result is queryable as "peaka"."mtquery"."".
inputQuery:
type: string
description: >-
The SQL query. For a materialized query created from an existing
query (via inputQueryRefId), this holds the snapshot of the source
query's SQL resolved when the query was created or last updated with
the reference.
queryType:
type: string
description: The type of the query.
enum:
- PLAIN
- MATERIALIZED
schedule:
$ref: '#/components/schemas/MaterializedQuerySchedule'
path:
type: string
description: >-
The folder path of the query (e.g. "/analytics/dashboards"). Null if
not in any folder.
nullable: true
folderId:
type: string
description: >-
The ID of the folder containing this query. Null if not in any
folder.
nullable: true
description: A saved query belonging to a project.
MaterializedQuerySchedule:
type: object
properties:
type:
type: string
description: Type of schedule.
enum:
- interval
- cron
- none
cronExpression:
type: string
description: >-
UNIX cron expression (minute hour day-of-month month day-of-week),
e.g. '0 0 * * *' for every day at midnight. Set only when the
schedule type is 'cron'.
nullable: true
example: 0 0 * * *
repeatDuration:
type: string
description: >-
ISO-8601 duration between refreshes, e.g. 'PT6H' (every 6 hours),
'PT12H' (twice daily), 'P1D' (daily). Set only when the schedule
type is 'interval'.
nullable: true
example: PT12H
timezone:
type: string
description: >-
IANA timezone used to evaluate the cron expression, e.g. 'UTC' or
'Europe/Istanbul'. Set only when the schedule type is 'cron'.
nullable: true
example: UTC
description: >-
Schedule configuration of a materialized query. Provide EITHER an
interval schedule (`type=interval` with `repeatDuration`) OR a cron
schedule (`type=cron` with `cronExpression` and optional `timezone`).
Use `type=none` for no schedule. The fields that do not apply to the
chosen type are omitted.
nullable: true
example:
type: cron
cronExpression: 0 0 * * *
timezone: UTC
securitySchemes:
bearerAuth:
type: http
description: >-
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
scheme: bearer
bearerFormat: Api Key
````