Documents
Bnder API documentation for Documents. Read the API Overview to get started and learn more.
Get all documents
Gets all documents the specified guild. Can be filtered by project id and number of results limited. Defaults to 100 results maximum
GET/consumer/v1/guilds/guildId /documents
| 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 - Documents retrieved
| Field | Type | Description |
|---|---|---|
| documents | array | List of documents |
Create a new document
Creates a new document in the specified guild
POST/consumer/v1/guilds/guildId /documents
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
| Field | Type | Description |
|---|---|---|
| project_id | string | ID of the project the document belongs to |
| title | string | Title of the document |
| content | string | Content of the document |
| topic_id | string | ID of the topic the document belongs to |
| in_bin | boolean | Whether the document is in the bin |
| is_public | boolean | Whether the document is public |
Response
Status: 200 - Document created
| Field | Type | Description |
|---|---|---|
| id | string | ID of the document |
| project_id | string | ID of the project the document belongs to |
| title | string | Title of the document |
| content | string | Content of the document |
| topic_id | string | ID of the topic the document belongs to |
| in_bin | boolean | Whether the document is in the bin |
| delete_date | string | Date the document will be deleted if in the bin |
| last_modified | string | Date the document was last modified |
| is_public | boolean | Whether the document is public |
Get a document
Gets the document data by id in the specified guild
GET/consumer/v1/guilds/guildId /documents/documentId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| documentId | The ID of the document |
Request body
empty
Response
Status: 200 - Document retrieved
| Field | Type | Description |
|---|---|---|
| id | string | ID of the document |
| project_id | string | ID of the project the document belongs to |
| title | string | Title of the document |
| content | string | Content of the document |
| topic_id | string | ID of the topic the document belongs to |
| in_bin | boolean | Whether the document is in the bin |
| delete_date | string | Date the document will be deleted if in the bin |
| last_modified | string | Date the document was last modified |
| is_public | boolean | Whether the document is public |
Update a document
Updates a document in the specified guild
PUT/consumer/v1/guilds/guildId /documents/documentId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| documentId | The ID of the document |
Request body
| Field | Type | Description |
|---|---|---|
| project_id | string | The project id |
| title | string | The title of the document |
| content | string | The content of the document |
| topic_id | string | The topic id |
| in_bin | boolean | Is the document in the bin |
| is_public | boolean | Whether the document is public |
| draft_title | string | The draft title of the document |
| draft_content | string | The draft content of the document |
Response
Status: 200 - Document updated
| Field | Type | Description |
|---|---|---|
| id | string | ID of the document |
| project_id | string | ID of the project the document belongs to |
| title | string | Title of the document |
| content | string | Content of the document |
| topic_id | string | ID of the topic the document belongs to |
| in_bin | boolean | Whether the document is in the bin |
| delete_date | string | Date the document will be deleted if in the bin |
| last_modified | string | Date the document was last modified |
| is_public | boolean | Whether the document is public |
Delete a document
Deletes a document in the specified guild
DELETE/consumer/v1/guilds/guildId /documents/documentId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| documentId | The ID of the document |
Request body
empty
Response
Status: 204 - Document deleted
empty response