Interface

APIRole

Role from GET /guilds/{id}/roles. `permissions` is a bitfield as string (e.g. "8933636165185").

Properties

color: number

Role color as RGB integer.

hoist: boolean

Whether the role is hoisted (displayed separately).

hoist_position?: number | null

Hoisted position (displayed separately in member list).

id: Snowflake

Role ID.

mentionable: boolean

Whether the role can be mentioned.

name: string

Role name.

permissions: string

Permissions bitfield as string.

position: number

Sort position in the role list.

unicode_emoji?: string | null

Unicode emoji for the role (if no custom icon).