> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Guild API Reference

Guild feature




A microservice that provides guild functionality for multiplayer games.
It manages guild members and controls the permissions available to each member.

In GS2-Guild, a guild itself is treated as a single “guild user.”
This allows guilds to own and manage shared data such as levels, experience points, stamina, and skill trees using standard GS2 user-based microservices.

Guild members can operate as the guild user through federation and use GS2 APIs with guild-specific access tokens.
Fine-grained permission control is also supported, enabling features such as allowing only guild masters to purchase shared guild items through GS2-Showcase.

Guild settings are managed via the GuildModel. Set the initial and maximum member counts with `defaultMaximumMemberCount` and `maximumMemberCount`. Specify the guild master's inactivity period with `inactivityPeriodDays` to enable automatic succession. `rejoinCoolTimeMinutes` sets the cooldown period for rejoining after leaving. `maxConcurrentJoinGuilds` and `maxConcurrentGuildMasterCount` also allow setting limits on the number of guilds a member can join simultaneously and the number of guilds a member can lead.

A role is an entity that corresponds to the position of a player belonging to a guild, and defines the type of API that can be executed.
Up to 10 types of roles can be defined in one guild model.

A policy document of GS2-Identifier can be defined for a role.
APIs can be called within the range that both the permissions held before switching to the guild user and the permissions of the role allow.

[Introduction to Microservices / GS2-Guild](../../microservices/guild)



- [GS2-Guild Deploy/CDK Reference](/api_reference/guild/deploy/)
  
- [GS2-Guild Master Data Reference](/api_reference/guild/master_data/)
  
- [GS2-Guild Script Trigger Reference](/api_reference/guild/script/)
  
- [GS2-Guild SDK API Reference](/api_reference/guild/sdk/)
  
- [GS2-Guild SDK for Game Engine API Reference](/api_reference/guild/game_engine/)
  
- [GS2-Guild Transaction Actions](/api_reference/guild/stamp_sheet/)