Skip to main content
POST
/
api
/
v1
/
orgs
Create Org
curl --request POST \
  --url https://api.example.com/api/v1/orgs/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "This project aims to...",
  "status": "active",
  "metadata": {
    "priority": "",
    "team_size": ""
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The name of the project

Example:

"My Project"

​
description
string | null

A detailed description of the project

Example:

"This project aims to..."

​
status
string | null
default:active

Current status of the project

Example:

"active"

​
metadata
Metadata · object

Additional project metadata in key-value pairs

Example:
{ "priority": "", "team_size": "" }

Response

Successful Response