Skip to content

Commit 808d94b

Browse files
committed
document guild bans pagination
1 parent 2f854d3 commit 808d94b

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/Change_Log.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Change Log
22

3+
## Guild Bans Pagination
4+
5+
#### Mar 31, 2022
6+
7+
The `GET /guilds/{guild.id}/bans` endpoint has been migrated to require pagination to improve reliability and stability. Check out the [endpoint docs](#DOCS_RESOURCES_GUILD/get-guild-bans) for more information.
8+
39
## Interaction Modals and Application Command Attachment Option Type
410

511
#### Feb 8, 2022

docs/resources/Guild.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -897,6 +897,16 @@ Remove a member from a guild. Requires `KICK_MEMBERS` permission. Returns a 204
897897

898898
Returns a list of [ban](#DOCS_RESOURCES_GUILD/ban-object) objects for the users banned from this guild. Requires the `BAN_MEMBERS` permission.
899899

900+
###### Query String Params
901+
902+
| Field | Type | Description | Default |
903+
| ------------ | ------- | ------------------------------------------------------------------------------ | ------- |
904+
| limit? | number | number of users to return (up to maximum 1000) | 1000 |
905+
| before? * | snowflake | consider only users before given user id | null |
906+
| after? * | snowflake | consider only users after given user id | null |
907+
908+
\* Provide a user id to `before` and `after` for pagination. Users will always be returned in ascending order by `user_id`. If both `before` and `after` are provided, only `before` is respected.
909+
900910
## Get Guild Ban % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/bans/{user.id#DOCS_RESOURCES_USER/user-object}
901911

902912
Returns a [ban](#DOCS_RESOURCES_GUILD/ban-object) object for the given user or a 404 not found if the ban cannot be found. Requires the `BAN_MEMBERS` permission.

0 commit comments

Comments
 (0)