Documentation

ListGroupMembers

Lists all members for a group

Request Details

Gets a list of members and the roles they belong to within the group. If the caller does not have permission to view the role, and the member is in no other role, the member is not displayed. Returns a list of entities that are members of the group.

ListGroupMembersRequest
Request Properties
Group (required) EntityKey

ID of the group to list the members and roles for

POST https://{{TitleID}}.playfabapi.com/Group/ListGroupMembers
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  }
}
        

Response Details

ListGroupMembersResponse
Result Properties
Members List<EntityMemberRole>

The requested list of roles and member entity IDs.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

EntityToken

Possible Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089