Skip to main content
GET
/
organizations
/
{organizationId}
/
workspaces
/
{workspaceId}
/
projects
List Projects
curl --request GET \
  --url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/projects \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "SksnYuxH",
    "name": "Anapp23334",
    "description": null,
    "domain": "anapp2-rfto",
    "webhookBaseUrl": "https://anapp2-rfto--test.api.peaka.host",
    "createdAt": "2023-08-21T11:09:04.699714310Z",
    "workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"
  },
  {
    "id": "0IQ6f4QB",
    "name": "App Deneme",
    "description": null,
    "domain": "appdeneme-wmdp",
    "webhookBaseUrl": "https://appdeneme-wmdp--test.api.peaka.host",
    "createdAt": "2023-12-14T12:38:55.025274418Z",
    "workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"
  }
]

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

​
organizationId
string
required
​
workspaceId
string
required

Response

200 - application/json

Successful operation

​
id
string

Project ID

​
name
string

Project name

​
description
string

Descriptive text about the project

​
domain
string

Domain of the project

​
webhookBaseUrl
string

Webhook base URL

​
createdAt
string

The date and time the project was created

​
owner
string

The owner of the project

​
workspaceId
string

The workspace to which the project belongs