Guilds
Read the API Overview to get started and learn more.
Get all guild limits
Get all guild limits and current usage
GET /guilds/guildId/limits
Parameters
guildId The id of a discord guild
Responses
200 Response (All guild limits and usages):
| Response 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_documents | number | Maximal number of documents that can be created in the guild |
| max_labels | number | Maximal number of labels that can be created in the guild |
| max_events | number | Maximal number of events 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_documents | number | Current number of documents in the guild |
| current_labels | number | Current number of labels in the guild |
| current_events | number | Current number of events in the guild |
Get all supported timezones
Get all supported timezones
GET /guilds/guildId/timezones
Parameters
guildId The id of a discord guild
Responses
200 Response (All supported timezones):
| Response Field | Type | Description |
|---|---|---|
| timezones | array | List of timezones in the guild |
Get a guild
Get guild settings and properties by the guild id
GET /guilds/guildId
Parameters
guildId The id of a discord guild
Responses
200 Response (The guild):
| Response Field | Type | Description |
|---|---|---|
| language | string | Language of the guild |
| logging_webhook_url (optional) | string | URL to send logs to |
| auto_labeling_enabled | boolean | Whether auto labeling is enabled |
| 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 (optional) | string | GitHub key for the guild, uses for GitHub integration |
| private_messages_enabled | boolean | Whether private messages are enabled |
| log_level | number | Log level for the guild |
Update settings for a guild
Update settings for a guild
PUT /guilds/guildId
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| language (optional) | string | The language of the guild. Must be a valid language code or ‘en’ for English. |
| logging_webhook_url (optional) | string | The URL of the logging webhook for the guild. |
| log_level (optional) | number | The logging level for the guild. |
| auto_labeling_enabled (optional) | boolean | Whether auto-labeling is enabled for the guild. |
| timezone (optional) | string | The timezone of the guild. |
| dateformat (optional) | string | The date format of the guild. |
| private_responses (optional) | boolean | Whether private responses are enabled for the guild. |
| auto_priority (optional) | boolean | Whether auto-priority is enabled for the guild. |
| user_languages (optional) | boolean | Whether auto-assign is enabled for the guild. |
| user_timezones (optional) | boolean | Whether user timezones are enabled for the guild. |
| default_assignee (optional) | number | The default assignee for tasks. |
| error_reporting (optional) | boolean | Whether error reporting is enabled for the guild. |
| week_start_day (optional) | string | The day of the week that the guild considers the start of the week. |
| private_messages_enabled (optional) | boolean | Whether private messages are enabled for the guild. |
Responses
200 Response (Updated guild):
| Response Field | Type | Description |
|---|---|---|
| language | string | Language of the guild |
| logging_webhook_url (optional) | string | URL to send logs to |
| auto_labeling_enabled | boolean | Whether auto labeling is enabled |
| 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 (optional) | string | GitHub key for the guild, uses for GitHub integration |
| private_messages_enabled | boolean | Whether private messages are enabled |
| log_level | number | Log level for the guild |
