roles_list
roles_list
Section titled “roles_list”Category: roles
List all roles in a guild.
When to use
Section titled “When to use”discover role IDs, audit hierarchy + permissions.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to list roles for |
Returns
Section titled “Returns”\{roles:[\{id,name,color,position,permissions,mentionable,hoist,managed\}], count\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
roles | array | yes | |
count | number | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |