POST
/
organizations
/
{organizationId}
/
workspaces
/
{workspaceId}
/
projects
Create Project
curl --request POST \
  --url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Sample Project Name"
}'
{
  "id": "URNg0GIj",
  "name": "Sample Project Name",
  "description": "Non accusantium ducimus accusantium. Laborum eum accusamus sit sit hic eaque doloremque. Occaecati blanditiis facere consequuntur consectetur culpa reiciendis hic tempore dolorem. Saepe impedit nam necessitatibus maxime numquam voluptatum cum. Adipisci mollitia blanditiis sint inventore ex commodi occaecati ipsam quas.",
  "domain": "sampleprojectname-cdcn",
  "webhookBaseUrl": "https://sampleprojectname-cdcn--test.api.peaka.host",
  "createdAt": "2024-09-10T10:11:02.385253956Z",
  "workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"
}

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

Path Parameters

organizationId
string
required
workspaceId
string
required

Body

application/json

Project to create

name
string
required

Project name

Example:

"My Project"

description
string

Descriptive text about the project

Example:

"This is a project that does something"

Response

200 - application/json

Project created

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