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/consumer/v1/guilds/guildId /topics
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| limit | The number of items to return |
| project_id | The ID of the project |
Request body
empty
Response
Status: 200 - Retrieved topics
| Field | Type | Description |
|---|---|---|
| topics | array | The list of topics |
Create a topic
Create a new topic in the guild
POST/consumer/v1/guilds/guildId /topics
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
empty
Response
Status: 200 - Created topic
| 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 | 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/consumer/v1/guilds/guildId /topics/topicId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| topicId | The ID of the topic |
Request body
empty
Response
Status: 200 - Retrieved topic
| 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 | 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/consumer/v1/guilds/guildId /topics/topicId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| topicId | The ID of the topic |
Request body
empty
Response
Status: 200 - Updated topic
| 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 | 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/consumer/v1/guilds/guildId /topics/topicId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| topicId | The ID of the topic |
Request body
empty
Response
Status: 204 - Topic deleted
empty response