Public Documents
Bnder API documentation for Public Documents. Read the API Overview to get started and learn more.
Get all public documents
Gets all public documents the specified guild to the domain. Can be filtered by project id and number of results limited. Defaults to 100 results maximum
GET/consumer/v1/page/pageDomain /documents
| Parameters | Description |
|---|---|
| pageDomain | The public domain of a page |
| 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 |
| topics | array | List of topics related to the documents |
| projects | array | List of projects related to the documents |
| workspace_name | string | Name of the workspace the documents belong to |
Get a single public document
Gets a single public document by id
GET/consumer/v1/page/pageDomain /documents/documentId
| Parameters | Description |
|---|---|
| pageDomain | The public domain of a page |
| 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 |