Topics
Read the API Overview to get started and learn more.
Create topic
Create a new topic.
POST
/
guilds
/
guildId
/
topics
/
topicId
Request body
| Field | Type | Description |
|---|---|---|
| name | string | Name of the topic |
| project_id | string | Id of a project in the guild |
| in_bin (optional) | boolean | Whether the topic should be in bin |
Response body
Returns a Topic Entity
Returns a 200 status
Delete topic
Delete a topic
DELETE
/
guilds
/
guildId
/
topics
/
topicId
Request body
-
Response body -
Returns a 204 status
Update topic
Updates the data of a topic.
PUT
/
guilds
/
guildId
/
topics
/
topicId
Request body
| Field | Type | Description |
|---|---|---|
| name (optional) | string | Name of the topic |
| project_id (optional) | string | Id of a project in the guild |
| in_bin (optional) | boolean | Whether the topic should be in bin |
Response body
Returns a Topic Entity
Returns a 200 status
Get a topic
Returns info about a single topic.
GET
/
guilds
/
guildId
/
topics
/
topicId
Request body -
Response body
Returns a Topic Entity
Returns a 200 status
Get all topics
Returns a list of all topics in the guild.
GET
/
guilds
/
guildId
/
topics
/
topicId
Query Parameters
| Field | Type | Description |
|---|---|---|
| limit (optional) | number | Max amount of results. Defaults to 100. |
| project_id (optional) | string | Id of a project to return only topics inside this project. |
Request body -
Response body
Returns a list of Topic Entities.
Returns a 200 status
Topic Entity
| Field | Type | Description |
|---|---|---|
| id | string | The topic ID |
| name | string | The topic name |
| in_bin | boolean | Whether the topic is in bin |
| delete_at (optional) | string | The deletion date of the topic |
