API
Guilds

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.

GET
/
guilds
/
guildId
/
limits

Request body

-

Response body

FieldTypeDescription
max_tasksnumberMaximum amount of tasks allowed for this guild
max_projectsnumberMaximum amount of projects allowed for this guild
max_topicsnumberMaximum amount of topics allowed for this guild
max_documentsnumberMaximum amount of documents allowed for this guild
max_labelsnumberMaximum amount of labels allowed for this guild
current_tasksnumberHow many tasks are currently in this guild
current_projectsnumberHow many projects are currently in this guild
current_topicsnumberHow many topics are currently in this guild
current_documentsnumberHow many documents are currently in this guild
current_labelsnumberHow many labels are currently in this guild

Returns a 200 status

Get timezones

Returns all supported timezones.

GET
/
guilds
/
guildId
/
timezones

Request body

-

Response body

Returns a string list of all timezones available.

Returns a 200 status

Update guild

Updates settings of the guild.

PUT
/
guilds
/
guildId

Request body

FieldTypeDescription
language (optional)stringThe language code
logging_webhook_url (optional)stringThe url of a logging webhook. "" to remove
log_level (optional)stringThe log level of the logging webhook. (0, 1 or 2)
auto_labeling_enabled (optional)booleanWhether auto labeling should be enabled or not
timezone (optional)stringThe name of a timezone
dateformat (optional)stringA supported dateformat
auto_priority (optional)booleanWhether auto priority should be enabled or disabled
user_languages (optional)booleanWhether users should be able to set their own language preference
user_timezones (optional)booleanWhether users should be able to set their own timezone preference
default_assignee (optional)numberWhat to set as a default assignee, if none was specified in the task. (0 = None, 1 = Creator, 2 = Project manager)
error_reporting (optional)booleanIf true, app clients will report errors to bnder.
week_start_day (optional)stringThe day a week starts in the guild (monday or sunday)
private_messages_enabled (optional)booleanWhether 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.

POST
/
guilds
/
guildId

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.

GET
/
guilds
/
guildId
/
roles

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.

GET
/
guilds

Query params

FieldTypeDescription
access_tokenstringThe users access token
getAll (optional)booleanIf 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.

GET
/
guilds
/
guildId

Request body -

Response body

Returns a Guild Entity

Returns a 204 status

Guild Entity

FieldTypeDescription
languagestringThe language of the guild
logging_webhook_urlstring / nullThe url of a set webhook used for logging
log_levelnumberThe log level of the guild. (0, 1 or 2)
auto_labeling_enabledbooleanTrue if auto labeling is enabled in the guild
timezonestringName of the timezone the guild has set
dateformatstringThe dateformat used by the guild
auto_prioritybooleanTrue if auto labeling is enabled in the guild
user_languagesbooleanTrue if users can set their own preferred language
user_timezonesbooleanTrue if users can set their own preferred timezone
default_assigneenumberWhat to set as a default assignee, if none was specified in the task. (0 = None, 1 = Creator, 2 = Project manager)
error_reportingbooleanIf true, app clients will report errors to bnder.
week_start_daystringThe day a week starts in the guild (monday or sunday)
private_messages_enabledbooleanWhether private messages are enabled or not for assign task notifications

Social Media

Twitter

Instagram

Discord

GitHub

YouTube

bnder logo