Topics
Bnder API documentation for Topics. Read the API Overview to get started and learn more.
Get all topics
Get all topics in the guild. Can be filtered by project id and limited. Default limit is 100
GET /guilds/guildId/topics
Parameters
guildId The id of a discord guild
limit The number of items to return
project_id The ID of the project
Responses
200 Response (Retrieved topics):
| Response Field | Type | Description |
|---|---|---|
| topics | array | The list of topics |
Create a topic
Create a new topic in the guild
POST /guilds/guildId/topics
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| name | string | The name of the topic |
| project_id | string | The ID of the project |
| in_bin (optional) | boolean | Whether the topic is a bin |
Responses 200 Response (Created topic):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the topic |
| name | string | The name of the topic |
| project_id | string | The ID of the project |
| delete_at (optional) | string | The date and time the topic was deleted |
| in_bin | boolean | Whether the topic is a bin |
Get a topic
Get a topic by the topic id
GET /guilds/guildId/topics/topicId
Parameters
guildId The id of a discord guild
topicId The ID of the topic
Responses
200 Response (Retrieved topic):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the topic |
| name | string | The name of the topic |
| project_id | string | The ID of the project |
| delete_at (optional) | string | The date and time the topic was deleted |
| in_bin | boolean | Whether the topic is a bin |
Update a topic
Update an existing topic in the guild
PUT /guilds/guildId/topics/topicId
Parameters
guildId The id of a discord guild
topicId The ID of the topic
Request body
| Request Field | Type | Description |
|---|---|---|
| name (optional) | string | The name of the topic |
| project_id (optional) | string | The ID of the project |
| in_bin (optional) | boolean | If the topic is a bin |
Responses 200 Response (Updated topic):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the topic |
| name | string | The name of the topic |
| project_id | string | The ID of the project |
| delete_at (optional) | string | The date and time the topic was deleted |
| in_bin | boolean | Whether the topic is a bin |
Delete a topic
Delete a topic in the guild and all documents inside the topic
DELETE /guilds/guildId/topics/topicId
Parameters
guildId The id of a discord guild
topicId The ID of the topic
Responses
204 Response (Topic deleted): Empty response.