Skip to main content
GET
/
projects
/
{projectId}
Read Project
curl --request GET \
  --url https://partner.peaka.studio/api/v1/projects/{projectId} \
  --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"
}

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

Response

200 - application/json

Successful operation

Project

​
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