API Documentation
Organization -- Organizations
Organization -- Workspaces
Organization -- Projects
Projects (Deprecated)
Projects -- Api Key
Connections
Data -- Catalogs
Data -- Internal Tables
Data -- Queries
Data -- Semantic Catalogs
Data -- Cache
Data -- Parametric Tables
Embedded Peaka Api
Supported Drivers
Data -- Metadata
- PUTUpdate Metadata ai usage per catalog level
- PUTUpdate Metadata ai usage per schema level
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the column.
- DELDelete categorical values from the column meta and remove the scheduled job
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- POSTRefresh Project Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- GETSemantic query metadata for the project.
- GETSemantic query golden sqls for the project.
- DELDelete golden sql from the project.
AI -- Agent
AI -- AgentV2
Data -- SQL
Organization -- Organizations
List Organizations
Retrieves all the organizations accessible by the authenticated user.
An Organization is the highest-level resource that can contain multiple Workspaces.
GET
/
organizations
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/organizations \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"id": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"name": "ABC Organization",
"owner": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"createdAt": "2025-03-25T12:28:48.737355Z",
"iconFileId": null,
"description": "Default Organization"
}
]
Authorizations
Use the Authorization header with the value 'Bearer <apiKey>' 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
Response
200 - application/json
List of Organizations
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/organizations \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"id": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"name": "ABC Organization",
"owner": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"createdAt": "2025-03-25T12:28:48.737355Z",
"iconFileId": null,
"description": "Default Organization"
}
]
Assistant
Responses are generated using AI and may contain mistakes.