Guilds
Read the API Overview to get started and learn more.
Get limits
All guilds have a limit in how many objects can be created in them. This endpoints returns the limits applied to the requested guild and the current usage.
Request body
-
Response body
Field | Type | Description |
---|---|---|
max_tasks | number | Maximum amount of tasks allowed for this guild |
max_projects | number | Maximum amount of projects allowed for this guild |
max_topics | number | Maximum amount of topics allowed for this guild |
max_documents | number | Maximum amount of documents allowed for this guild |
max_labels | number | Maximum amount of labels allowed for this guild |
current_tasks | number | How many tasks are currently in this guild |
current_projects | number | How many projects are currently in this guild |
current_topics | number | How many topics are currently in this guild |
current_documents | number | How many documents are currently in this guild |
current_labels | number | How many labels are currently in this guild |
Returns a 200 status
Get timezones
Returns all supported timezones.
Request body
-
Response body
Returns a string list of all timezones available.
Returns a 200 status
Update guild
Updates settings of the guild.
Request body
Field | Type | Description |
---|---|---|
language (optional) | string | The language code |
logging_webhook_url (optional) | string | The url of a logging webhook. "" to remove |
log_level (optional) | string | The log level of the logging webhook. (0, 1 or 2) |
auto_labeling_enabled (optional) | boolean | Whether auto labeling should be enabled or not |
timezone (optional) | string | The name of a timezone |
dateformat (optional) | string | A supported dateformat |
auto_priority (optional) | boolean | Whether auto priority should be enabled or disabled |
user_languages (optional) | boolean | Whether users should be able to set their own language preference |
user_timezones (optional) | boolean | Whether users should be able to set their own timezone preference |
default_assignee (optional) | number | What to set as a default assignee, if none was specified in the task. (0 = None, 1 = Creator, 2 = Project manager) |
error_reporting (optional) | boolean | If true, app clients will report errors to bnder. |
week_start_day (optional) | string | The day a week starts in the guild (monday or sunday) |
private_messages_enabled (optional) | boolean | Whether private messages are enabled or not for assign task notifications |
Response body
Returns a Guild Entity.
Returns a 200 status
Register a new guild
This registers a new guild, the bot is already invited to, but isn't showing in the app yet.
This route is not available to api users.
Request body -
Response body -
Returns a 204 status
Get guild roles
Returns a list of all roles created in the guild.
This route is not available to api users.
Request body -
Response body
Returns an array of discord role objects.
Returns a 204 status
Get users guilds
Returns all guilds the user is on. When "getAll" is not set to true, only guilds of the user that are already connected to bnder services are returned.
This route is not available to api users.
Query params
Field | Type | Description |
---|---|---|
access_token | string | The users access token |
getAll (optional) | boolean | If true, all guilds the user is on are returned |
Request body -
Response body
Returns an array of discord guild objects.
Returns a 204 status
Get guild
Returns the settings of a guild.
Request body -
Response body
Returns a Guild Entity
Returns a 204 status
Guild Entity
Field | Type | Description |
---|---|---|
language | string | The language of the guild |
logging_webhook_url | string / null | The url of a set webhook used for logging |
log_level | number | The log level of the guild. (0, 1 or 2) |
auto_labeling_enabled | boolean | True if auto labeling is enabled in the guild |
timezone | string | Name of the timezone the guild has set |
dateformat | string | The dateformat used by the guild |
auto_priority | boolean | True if auto labeling is enabled in the guild |
user_languages | boolean | True if users can set their own preferred language |
user_timezones | boolean | True if users can set their own preferred timezone |
default_assignee | number | What to set as a default assignee, if none was specified in the task. (0 = None, 1 = Creator, 2 = Project manager) |
error_reporting | boolean | If true, app clients will report errors to bnder. |
week_start_day | string | The day a week starts in the guild (monday or sunday) |
private_messages_enabled | boolean | Whether private messages are enabled or not for assign task notifications |