projects

12 endpoints at a glance

Method	Path	Summary
GET	/projects	List Projects
POST	/projects	Create Project
DELETE	/projects/{project_id}	Delete Project
GET	/projects/{project_id}	Get Project
PATCH	/projects/{project_id}	Update Project
GET	/projects/{project_id}/children	List Children
GET	/projects/{project_id}/descendants	List Descendants
GET	/projects/{project_id}/members	List Members
POST	/projects/{project_id}/members	Add Member
DELETE	/projects/{project_id}/members/{member_username}	Remove Member
PATCH	/projects/{project_id}/members/{member_username}	Change Member Role
GET	/projects/inbox	Get Inbox

projects

---

List Projects

GET

/projects

Parameters

Header Parameters

authorization

Query Parameters

status

include_archived

Type

boolean

Default

false

page

Type

integer

Default

1

limit

Type

integer

Default

50

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/projects

Playground

Headers

authorization

Variables

Key

Value

status

include_archived

page

limit

Samples

---

Create Project

POST

/projects

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"status": "active",

  

"start_date": "string",

  

"due_date": "string",

  

"tag_ids": [

  

  

"string"

  

],

  

"parent_project_id": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/projects

Playground

Headers

authorization

Body

Samples

---

Get Inbox

GET

/projects/inbox

Return (or create) the user's Inbox project.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/projects/inbox

Playground

Headers

authorization

Samples

---

Get Project

GET

/projects/{project_id}

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/projects/{project_id}

Playground

Headers

authorization

Variables

Key

Value

project_id*

Samples

---

Delete Project

DELETE

/projects/{project_id}

Hard delete a project AND all its tasks/comments/links.

Refuses to delete the Inbox. Archive (PATCH status=archived) is the
soft-keep option.

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/projects/{project_id}

Playground

Headers

authorization

Variables

Key

Value

project_id*

Samples

---

Update Project

PATCH

/projects/{project_id}

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"status": "string",

  

"start_date": "string",

  

"due_date": "string",

  

"tag_ids": [

  

  

"string"

  

],

  

"custom_fields": {

  

  

"additionalProperties": "string"

  

},

  

"statuses": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string",

  

  

  

"kind": "string",

  

  

  

"color": "string",

  

  

  

"position": 0

  

  

}

  

],

  

"parent_project_id": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/projects/{project_id}

Playground

Headers

authorization

Variables

Key

Value

project_id*

Body

Samples

---

List Children

GET

/projects/{project_id}/children

Direct sub-projects visible to the caller (phase 6 hierarchy).

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/projects/{project_id}/children

Playground

Headers

authorization

Variables

Key

Value

project_id*

Samples

---

List Descendants

GET

/projects/{project_id}/descendants

Full visible sub-tree under a project (phase 6 hierarchy rollup).

Unlike /children (one level), this walks the whole tree. Each item
is a public_project so the caller gets every descendant's name +
effective statuses in one round trip — used by the parent's Tasks tab
to group sub-project tasks and resolve their status labels.

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/projects/{project_id}/descendants

Playground

Headers

authorization

Variables

Key

Value

project_id*

Samples

---

List Members

GET

/projects/{project_id}/members

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/projects/{project_id}/members

Playground

Headers

authorization

Variables

Key

Value

project_id*

Samples

---

Add Member

POST

/projects/{project_id}/members

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Request Body

application/json

{

  

"username": "string",

  

"role": "editor"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/projects/{project_id}/members

Playground

Headers

authorization

Variables

Key

Value

project_id*

Body

Samples

---

Remove Member

DELETE

/projects/{project_id}/members/{member_username}

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

member_username*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/projects/{project_id}/members/{member_username}

Playground

Headers

authorization

Variables

Key

Value

project_id*

member_username*

Samples

---

Change Member Role

PATCH

/projects/{project_id}/members/{member_username}

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

member_username*

Type

string

Required

Request Body

application/json

{

  

"role": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/projects/{project_id}/members/{member_username}

Playground

Headers

authorization

Variables

Key

Value

project_id*

member_username*

Body

Samples

---