GET
/
organizations
List Organizations
curl --request GET \
  --url https://partner.peaka.studio/api/v1/organizations \
  --header 'Authorization: Bearer <token>'
[
  {
    "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

​
Authorization
string
header
required

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

​
id
string<uuid>

The unique identifier of the organization

​
name
string

The name of the organization

​
owner
string<uuid>

The unique identifier of the user who created the organization

​
createdAt
string

The date and time the organization was created

​
iconFileId
string

The identifier of the file that contains the icon of the organization

​
description
string

Descriptive text about the organization