RESTGetAPICurrentUserGuildsQuery

@see

https://discord.com/developers/docs/resources/user#get-current-user-guilds

Index

Properties

• after
• before
• limit
• shard
• with_counts

Properties

optionalafter

after?: string

Get guilds after this guild ID

optionalbefore

before?: string

Get guilds before this guild ID

optionallimit

limit?: number

Max number of guilds to return (1-200)

@defaultValue

200

optionalshard

shard?: number

Only return guilds in this shard (0 to max_concurrency - 1)

@remarks

Apps using large bot sharding must provide the shard param. Valid values are 0 through max_concurrency - 1, where max_concurrency comes from the session start limit object on Get Gateway Bot. Iterate over every shard to retrieve the full guild list. Apps that are not using large bot sharding are unaffected.

Note that this value is different from the shard id used when connecting to the gateway.

@see

https://docs.discord.com/developers/resources/user#get-current-user-guilds

optionalwith_counts

with_counts?: boolean

Include approximate member and presence counts in response

@defaultValue

false