API
Documents

Documents

Read the API Overview to get started and learn more.

Create document

Create a new document.

POST
/
guilds
/
guildId
/
documents

Request body

FieldTypeDescription
project_idstringProject to create the document in
titlestringTitle of the document
contentstringContent of the document
topic_id (optional)stringThe topic the document should be placed in
in_bin (optional)booleanWhether the document should be in bin

Response body

Returns a Document Entity

Returns a 200 status

Delete document

Delete a document

DELETE
/
guilds
/
guildId
/
documents

Request body -

Response body -

Returns a 204 status

Update document

Update the data of a document

PUT
/
guilds
/
guildId
/
documents
/
documentId

Request body

FieldTypeDescription
project_id (optional)stringProject the document should be in
title (optional)stringTitle of the document
content (optional)stringContent of the document
topic_id (optional)stringThe topic the document should be placed in
in_bin (optional)booleanWhether the document should be in bin

Response body

Returns a Document Entity

Returns a 200 status

Get a single document

Returns the data of a single document.

GET
/
guilds
/
guildId
/
documents
/
documentId

Request body -

Response body

Returns a Document Entity

Returns a 200 status

Get documents

Returns the data of a multiple documents.

GET
/
guilds
/
guildId
/
documents

Query parameters

FieldTypeDescription
project_id (optional)stringReturns only documents in this project.
limit (optional)numberThe max number of documents to return. Defaults to 100

Request body -

Response body

Returns a list of Document Entities

Returns a 200 status

Document Entity

FieldTypeDescription
idstringThe topic ID
titlestringTitle of the document
contentstringThe content of the document
topic_id (optional)stringId of the topic the document is in
in_binbooleanWhether the topic is in bin
delete_date (optional)stringThe deletion date of the topic

Social Media

X (Twitter)

Instagram

Discord

GitHub

YouTube

bnder logo