APIDocuments

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 /guilds/guildId/documents
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 (Documents retrieved):

Response FieldTypeDescription
documentsarrayList of documents

Create a new document

Creates a new document in the specified guild

POST /guilds/guildId/documents
Parameters

guildId The id of a discord guild
Request body

Request FieldTypeDescription
project_idstringID of the project the document belongs to
titlestringTitle of the document
contentstringContent of the document
topic_id (optional)stringID of the topic the document belongs to
in_bin (optional)booleanWhether the document is in the bin

Responses 200 Response (Document created):

Response FieldTypeDescription
idstringID of the document
project_idstringID of the project the document belongs to
titlestringTitle of the document
contentstringContent of the document
topic_id (optional)stringID of the topic the document belongs to
in_binbooleanWhether the document is in the bin
delete_date (optional)stringDate the document will be deleted if in the bin

Get a document

Gets the document data by id in the specified guild

GET /guilds/guildId/documents/documentId
Parameters

guildId The id of a discord guild
documentId The ID of the document
Responses 200 Response (Document retrieved):

Response FieldTypeDescription
idstringID of the document
project_idstringID of the project the document belongs to
titlestringTitle of the document
contentstringContent of the document
topic_id (optional)stringID of the topic the document belongs to
in_binbooleanWhether the document is in the bin
delete_date (optional)stringDate the document will be deleted if in the bin

Update a document

Updates a document in the specified guild

PUT /guilds/guildId/documents/documentId
Parameters

guildId The id of a discord guild
documentId The ID of the document
Request body

Request FieldTypeDescription
project_id (optional)stringThe project id
title (optional)stringThe title of the document
content (optional)stringThe content of the document
topic_id (optional)stringThe topic id
in_bin (optional)booleanIs the document in the bin

Responses 200 Response (Document updated):

Response FieldTypeDescription
idstringID of the document
project_idstringID of the project the document belongs to
titlestringTitle of the document
contentstringContent of the document
topic_id (optional)stringID of the topic the document belongs to
in_binbooleanWhether the document is in the bin
delete_date (optional)stringDate the document will be deleted if in the bin

Delete a document

Deletes a document in the specified guild

DELETE /guilds/guildId/documents/documentId
Parameters

guildId The id of a discord guild
documentId The ID of the document
Responses 204 Response (Document deleted): Empty response.

Social Media

X (Twitter)

Instagram

Discord

GitHub

YouTube

WhatsApp

bnder logo