Projects
Bnder API documentation for Projects. Read the API Overview to get started and learn more.
Get all projects
Get all projects of the guild
GET /guilds/guildId/projects
Parameters
guildId The id of a discord guild
Responses
200 Response (List of projects):
| Response Field | Type | Description |
|---|
Create a new project
Create a new project in the guild
POST /guilds/guildId/projects
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| name | string | Name of the project |
| is_personal | boolean | Whether this project should be created as a personal project for the creator |
| manager (optional) | string | The manager of the project |
| logging_webhook_url (optional) | string | The URL to send logging information to |
Responses 200 Response (Created project):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the project |
| name | string | The name of the project |
| is_personal | boolean | Whether the project is personal |
| in_bin (optional) | boolean | Whether the project is in bin |
| deleted_at (optional) | string | The date and time of deletion |
| manager (optional) | string | The ID of the manager |
| logging_webhook_url (optional) | string | The URL of the logging webhook |
Search across projects
Search across projects of the guild
GET /guilds/guildId/projects/search
Parameters
guildId The id of a discord guild
q The search query
search_tasks undefined
search_events undefined
search_documents undefined
Responses
200 Response (): Empty response.
Update a project
Update a project in the specified guild
PUT /guilds/guildId/projects/projectId
Parameters
guildId The id of a discord guild
projectId The ID of the project
Request body
| Request Field | Type | Description |
|---|---|---|
| name (optional) | string | The name of the project |
| in_bin (optional) | boolean | Whether the project is in bin |
| manager (optional) | string | The ID of the manager |
| is_personal (optional) | boolean | Whether the project is personal |
| logging_webhook_url (optional) | string | The URL to send logging information to |
Responses 200 Response (Updated project):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the project |
| name | string | The name of the project |
| is_personal | boolean | Whether the project is personal |
| in_bin (optional) | boolean | Whether the project is in bin |
| deleted_at (optional) | string | The date and time of deletion |
| manager (optional) | string | The ID of the manager |
| logging_webhook_url (optional) | string | The URL of the logging webhook |
Delete a project
Delete a project in the specified guild
DELETE /guilds/guildId/projects/projectId
Parameters
guildId The id of a discord guild
projectId The ID of the project
Responses
204 Response (Project deleted): Empty response.