LammaDevelopers Open Lamma

API reference

Read servers, roles and members.

Servers are called guilds in the API, as on Discord. A bot can only read servers its app is installed in.

#Get server

GET/v1/guilds/{guild_id}

Returns the server snapshot, with this install's effective scopes and intents.

#Get server channels

GET/v1/guilds/{guild_id}/channels

The channels the bot can see.

#Get server roles

GET/v1/guilds/{guild_id}/roles

The server's roles, highest first.

#List server members

GET/v1/guilds/{guild_id}/members

Needs the members.read scope, which follows the privileged guild_members intent. Members come in user id order.

QueryTypeNotes
limitinteger1 to 1,000
afteruser idStart after this user, to page through

#Get server member

GET/v1/guilds/{guild_id}/members/{user_id}

One member. Needs members.read.

#Server snapshot

FieldTypeNotes
idstring
namestring
descriptionstring or null
icon_idstring or null
owner_idstring
channelsarrayChannels the bot can see
categoriesarrayOnly categories holding a channel the bot can see
rolesarrayRoles
meobject{ roles, permissions }: the bot's own roles and server permissions

#Role object

FieldTypeNotes
idstring
namestring
colorstring or null
positionintegerHigher is more important
permissionsarray of stringsPermission names, such as send_messages
hoistbooleanShown separately in the member list
mentionableboolean
managedbooleantrue for an app's role, which only installs can change
defaultbooleantrue for @everyone

#Member object

FieldTypeNotes
userobjectThe user object
nicknamestring or null
joined_atintegerUnix milliseconds
rolesarray of ids

A member never includes presence, profile details or which other servers the person is in.