Skip to main content

APIGuildMember

https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure

Index

Properties

Properties

optionalavatar

avatar?: string

The member’s guild avatar hash

@see

https://discord.com/developers/docs/reference#image-formatting

optionalcommunication_disabled_until

communication_disabled_until?: string

When the user’s timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out

@see

https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ

deaf

deaf: boolean

Whether the user is deafened in voice channels

flags

flags: GuildMemberFlags

Guild member flags represented as a bit set, defaults to 0

@see

https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags

joined_at

joined_at: string

When the user joined the guild

mute

mute: boolean

Whether the user is muted in voice channels

optionalnick

nick?: string

This user’s guild nickname

optionalpending

pending?: boolean

Whether the user has not yet passed the guild’s Membership Screening requirements

@see

https://discord.com/developers/docs/resources/guild#membership-screening-object

optionalpermissions

permissions?: string

Total permissions of the member in the channel, including overwrites, returned when in the interaction object

optionalpremium_since

premium_since?: string

When the user started boosting the guild

@see

https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-

roles

roles: string[]

Array of role object IDs

@see

https://discord.com/developers/docs/topics/permissions#role-object

optionaluser

user?: APIUser

The user this guild member represents