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

# GS2-Friend API Reference

Friend/follow feature




It is used to realize in-game friendships.

There are two types of friends: friends that can be established only after a request is made and approved, and follows that can be established without the approval process of the other party.

Profile information can be included as metadata for game players.
Profile information has a scope of `public` `public to followers` `public to friends` and is made public to other players according to the scope.

The maximum number of friends and followers is 1,000 each, but additional restrictions may be added depending on the policy of each service you are connecting to.

A friend relationship is established when one of the players who wishes to become a friend sends a friend request to the other player, and the player who receives the friend request accepts it.

GS2-Friend provides an area that holds a player's profile.
The profile can hold arbitrary values, and three spaces are available.

A black list is an area that holds the list of user IDs a player has blocked.
It is purely a persistence feature; simply adding entries here does not by itself do anything.
You need to use the list recorded here separately as required, for example by passing it to the matchmaking conditions of GS2-Matchmaking.

[Introduction to Microservices / GS2-Friend](../../microservices/friend)



- [GS2-Friend Deploy/CDK Reference](/api_reference/friend/deploy/)
  
- [GS2-Friend Script Trigger Reference](/api_reference/friend/script/)
  
- [GS2-Friend SDK API Reference](/api_reference/friend/sdk/)
  
- [GS2-Friend SDK for Game Engine API Reference](/api_reference/friend/game_engine/)
  
- [GS2-Friend Transaction Actions](/api_reference/friend/stamp_sheet/)