Guilds
Bnder API documentation for Guilds. Read the API Overview to get started and learn more.
Get all guild limits
Get all guild limits and current usage
GET/consumer/v1/guilds/guildId /limits
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
empty
Response
Status: 200 - All guild limits and usages
| Field | Type | Description |
|---|---|---|
| max_projects | number | Maximal number of projects that can be created in the guild |
| max_topics | number | Maximal number of topics that can be created in the guild |
| max_labels | number | Maximal number of labels that can be created in the guild |
| current_projects | number | Current number of projects in the guild |
| current_topics | number | Current number of topics in the guild |
| current_labels | number | Current number of labels in the guild |
| premium_seats | number | Number of premium seats in the guild. This includes a seat for the guild owner. |
| premium_users | array | User IDs of premium users in the guild |
| max_task_assignees | number | Maximal number of labels that can be assigned to a single object in the guild |
| max_labels_per_object | number | Maximal number of labels that can be added to a task or document in the guild |
| max_event_invitees | number | Maximal number of invitees that can be added to an event in the guild |
| free_task_assignees | number | Number of task assignees that can be added to a task in the guild without a premium plan |
| task_assignees_per_seat | number | Maximal number of task assignees that can be added to a task in the guild per seat |
| free_projects | number | Number of projects that can be created in the guild without a premium plan |
| free_topics | number | Number of topics that can be created in the guild without a premium plan |
| free_labels | number | Number of labels that can be created in the guild without a premium plan |
| free_labels_per_object | number | Number of labels that can be assigned to a single object in the guild without a premium plan |
| free_event_invitees | number | Number of invitees that can be added to an event in the guild without a premium plan |
| storage_bytes_used | number | Storage used in bytes |
| storage_bytes_limit | number | Storage limit in bytes |
| free_milestones | number | Number of milestones that can be created in the guild without a premium plan |
| max_milestones | number | Maximal number of milestones that can be created in the guild |
| current_milestones | number | Current number of milestones in the guild |
| projects_per_seat | number | Maximal number of projects that can be created in the guild per seat |
| labels_per_seat | number | Maximal number of labels that can be created in the guild per seat |
| topics_per_seat | number | Maximal number of topics that can be created in the guild per seat |
| event_invites_per_seat | number | Maximal number of invitees that can be added to an event in the guild per seat |
| storage_bytes_per_seat | number | Maximal number of labels that can be assigned to a single object in the guild per seat |
| milestones_per_seat | number | Maximal number of milestones that can be created in the guild per seat |
| suggested_seats | number | Suggested number of seats for the guild |
Get all supported timezones
Get all supported timezones
GET/consumer/v1/guilds/guildId /timezones
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
empty
Response
Status: 200 - All supported timezones
| Field | Type | Description |
|---|---|---|
| timezones | array | List of timezones in the guild |
Get a guild
Get guild settings and properties by the guild id
GET/consumer/v1/guilds/guildId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
empty
Response
Status: 200 - The guild
| Field | Type | Description |
|---|---|---|
| language | string | Language of the guild |
| logging_webhook_url | string | URL to send logs to |
| auto_labeling_enabled | boolean | Whether auto labeling is enabled |
| auto_label_suggestions_enabled | boolean | Whether auto-label suggestions are enabled for the guild. |
| todo_suggestions_enabled | boolean | Whether todo suggestions are enabled for the guild. |
| auto_priority | boolean | Whether auto priority is enabled |
| timezone | string | Timezone of the guild |
| dateformat | string | Date format of the guild |
| private_responses | boolean | Whether private responses are enabled |
| user_languages | boolean | Whether user languages are enabled |
| user_timezones | boolean | Whether user timezones are enabled |
| default_assignee | number | Default assignee for tasks |
| error_reporting | boolean | Whether error reporting is enabled |
| week_start_day | string | Week start day for the guild |
| github_key | string | GitHub key for the guild, uses for GitHub integration |
| gitlab_key | string | GitLab key for the guild, uses for GitLab integration |
| private_messages_enabled | boolean | Whether private messages are enabled |
| log_level | number | Log level for the guild |
| task_cleanup_policy | number | Days after which tasks in the done state should be deleted. 0 removes it |
Update settings for a guild
Update settings for a guild
PUT/consumer/v1/guilds/guildId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
| Field | Type | Description |
|---|---|---|
| language | string | The language of the guild. Must be a valid language code or "en" for English. |
| logging_webhook_url | string | The URL of the logging webhook for the guild. |
| log_level | number | The logging level for the guild. |
| auto_labeling_enabled | boolean | Whether auto-labeling is enabled for the guild. |
| auto_label_suggestions_enabled | boolean | Whether auto-label suggestions are enabled for the guild. |
| todo_suggestions_enabled | boolean | Whether ToDo suggestions are enabled for the guild. |
| timezone | string | The timezone of the guild. |
| dateformat | string | The date format of the guild. |
| private_responses | boolean | Whether private responses are enabled for the guild. |
| auto_priority | boolean | Whether auto-priority is enabled for the guild. |
| user_languages | boolean | Whether auto-assign is enabled for the guild. |
| user_timezones | boolean | Whether user timezones are enabled for the guild. |
| default_assignee | number | The default assignee for tasks. |
| error_reporting | boolean | Whether error reporting is enabled for the guild. |
| week_start_day | string | The day of the week that the guild considers the start of the week. |
| private_messages_enabled | boolean | Whether private messages are enabled for the guild. |
| task_cleanup_policy | number | Days after which tasks in the done state should be deleted. 0 removes it |
| regenerate_github_key | boolean | Whether to regenerate the GitHub integration key for the guild. |
| regenerate_gitlab_key | boolean | Whether to regenerate the GitLab integration key for the guild. |
| owner_id | string | The owner id of the guild. |
| name | string | The name of the workspace. |
Response
Status: 200 - Updated guild
| Field | Type | Description |
|---|---|---|
| language | string | Language of the guild |
| logging_webhook_url | string | URL to send logs to |
| auto_labeling_enabled | boolean | Whether auto labeling is enabled |
| auto_label_suggestions_enabled | boolean | Whether auto-label suggestions are enabled for the guild. |
| todo_suggestions_enabled | boolean | Whether todo suggestions are enabled for the guild. |
| auto_priority | boolean | Whether auto priority is enabled |
| timezone | string | Timezone of the guild |
| dateformat | string | Date format of the guild |
| private_responses | boolean | Whether private responses are enabled |
| user_languages | boolean | Whether user languages are enabled |
| user_timezones | boolean | Whether user timezones are enabled |
| default_assignee | number | Default assignee for tasks |
| error_reporting | boolean | Whether error reporting is enabled |
| week_start_day | string | Week start day for the guild |
| github_key | string | GitHub key for the guild, uses for GitHub integration |
| gitlab_key | string | GitLab key for the guild, uses for GitLab integration |
| private_messages_enabled | boolean | Whether private messages are enabled |
| log_level | number | Log level for the guild |
| task_cleanup_policy | number | Days after which tasks in the done state should be deleted. 0 removes it |