AstralAPI Docs
Resources

Guild

Guild

Guilds are Astral servers.

Bots usually interact with guilds to:

  • inspect server metadata
  • list or manage channels
  • inspect or moderate members
  • manage bans, roles, stickers, or emojis

Common public endpoints

EndpointPurpose
POST /guildsCreate a guild
GET /users/@me/guildsList guilds visible to the current token
DELETE /users/@me/guilds/:guild_idLeave a guild
GET /guilds/:guild_idFetch a guild
PATCH /guilds/:guild_idUpdate a guild
POST /guilds/:guild_id/deleteDelete a guild
GET /guilds/:guild_id/channelsList channels in a guild
POST /guilds/:guild_id/channelsCreate a channel in a guild
PATCH /guilds/:guild_id/channelsBulk update channel ordering/structure
GET /guilds/:guild_id/membersList members
GET /guilds/:guild_id/members/:user_idFetch one member
PATCH /guilds/:guild_id/members/:user_idUpdate a member
DELETE /guilds/:guild_id/members/:user_idKick a member
GET /guilds/:guild_id/bansList bans
PUT /guilds/:guild_id/bans/:user_idBan a user
DELETE /guilds/:guild_id/bans/:user_idUnban a user

Related resource pages:

Fetch a guild

curl -s \
  -H "Authorization: Bot $TOKEN" \
  https://astraof.com/api/v1/guilds/<GUILD_ID>

Typical fields include:

{
  "id": "1470000000000000001",
  "name": "Astral Developers",
  "icon": "abc123",
  "owner_id": "1470000000000000002",
  "member_count": 42
}

List guild channels

curl -s \
  -H "Authorization: Bot $TOKEN" \
  https://astraof.com/api/v1/guilds/<GUILD_ID>/channels

Moderate a member

Fetch one member:

curl -s \
  -H "Authorization: Bot $TOKEN" \
  https://astraof.com/api/v1/guilds/<GUILD_ID>/members/<USER_ID>

Kick a member:

curl -X DELETE \
  -H "Authorization: Bot $TOKEN" \
  https://astraof.com/api/v1/guilds/<GUILD_ID>/members/<USER_ID>

Ban a member:

curl -X PUT \
  -H "Authorization: Bot $TOKEN" \
  -H "Content-Type: application/json" \
  -H "X-Audit-Log-Reason: Spam" \
  -d '{"delete_message_days":1}' \
  https://astraof.com/api/v1/guilds/<GUILD_ID>/bans/<USER_ID>

Roles on members

Add a role:

  • PUT /guilds/:guild_id/members/:user_id/roles/:role_id

Remove a role:

  • DELETE /guilds/:guild_id/members/:user_id/roles/:role_id

These operations still respect permissions and role hierarchy.

Vanity URL and guild settings

Public guild settings routes also include:

  • GET /guilds/:guild_id/vanity-url
  • PATCH /guilds/:guild_id/vanity-url

Guild update routes should only be used when your bot or token has the corresponding permissions.

On this page

Astral API Docs | Guild