Interface

APIRole

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

Properties

NameTypeDescription
colornumberRole color as RGB integer.
hoistbooleanWhether the role is hoisted (displayed separately).
hoist_position?number | nullHoisted position (displayed separately in member list).
idSnowflakeRole ID.
mentionablebooleanWhether the role can be mentioned.
namestringRole name.
permissionsstringPermissions bitfield as string.
positionnumberSort position in the role list.
unicode_emoji?string | nullUnicode emoji for the role (if no custom icon).