Nostrum.Api.list_guild_members

You're seeing just the function list_guild_members, go back to Nostrum.Api module for more information.
Link to this function

list_guild_members(guild_id, options \\ %{})

View Source

Specs

list_guild_members(Nostrum.Struct.Guild.id(), options()) ::
  error() | {:ok, [Nostrum.Struct.Guild.Member.t()]}

Gets a list of a guild's members.

If successful, returns {:ok, members}. Otherwise, returns a Nostrum.Api.error/0.

Options

  • :limit (integer) - max number of members to return (1-1000) (default: 1)
  • :after (Nostrum.Struct.User.id/0) - the highest user id in the previous page (default: 0)

Examples

Nostrum.Api.list_guild_members(41771983423143937, limit: 1)