Projects
Read the API Overview to get started and learn more.
List projects
List all projects in a guild.
GET
/
guilds
/
guildId
/
projects
Request body
-
Response body
Returns an array of ProjectEntity
Returns a 200 status
Create project
Create a new project.
POST
/
guilds
/
guildId
/
projects
Request body
| Field | Type | Description |
|---|---|---|
| name | string | Project name (1-32 characters) |
| is_personal | boolean | True if it`s a personal project |
| manager (optional) | string | The projects manager id |
Response body
Returns ProjectEntity
Returns a 200 status
Update project
Update a project.
PUT
/
guilds
/
guildId
/
projects
/
projectId
Request body
| Field | Type | Description |
|---|---|---|
| name (optional) | string | The new project name (1-32 characters) |
| in_bin (optional) | boolean | True if the project should be moved to the recycle bin. False if the project should be moved out of the bin |
| manager (optional) | string | Id of the project manager |
| is_personal (optional) | boolean | Whether the project should be personal or public |
Response body
Returns ProjectEntity
Returns a 200 status
Delete project
Delete a project by specified project ID.
DELETE
/
guilds
/
guildId
/
projects
/
projectId
Request body
-
Response body
-
Returns a 204 status
Project Entity
| Field | Type | Description |
|---|---|---|
| id | string | The project ID |
| name | string | The project name |
| is_personal | boolean | True if it`s a personal project |
| in_bin | boolean | True if the project should be moved to the recycle bin. False if the project should be moved out of the bin |
| deleted_at (optional) | date | Timestamp when this project was moved to the recycle bin |
| manager (optional) | string | Id of the user set to be the project manager |
