Groups - Get Group

Service:

Groups

API Version:

240412

Gets information about a group and its roles

POST https://titleId.playfabapi.com/Group/GetGroup

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Group	EntityKey	The identifier of the group
GroupName	string	The full name of the group

Responses

Name	Type	Description
200 OK	GetGroupResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
GetGroupRequest	Returns the ID, name, role list and other non-membership related information about a group.
GetGroupResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

GetGroupRequest

Returns the ID, name, role list and other non-membership related information about a group.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Group	EntityKey	The identifier of the group
GroupName	string	The full name of the group

GetGroupResponse

Name	Type	Description
AdminRoleId	string	The ID of the administrator role for the group.
Created	string	The server date and time the group was created.
Group	EntityKey	The identifier of the group
GroupName	string	The name of the group.
MemberRoleId	string	The ID of the default member role for the group.
ProfileVersion	number	The current version of the profile, can be used for concurrency control during updates.
Roles	object	The list of roles and names that belong to the group.