Groups - List Membership Opportunities
Lists all outstanding invitations and group applications for an entity
POST https://titleId.playfabapi.com/Group/ListMembershipOpportunities
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.). |
Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
Responses
Name | Type | Description |
---|---|---|
200 OK | ||
400 Bad Request |
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 |
---|---|
Api |
The basic wrapper around every failed API response |
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
Entity |
Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity. |
Group |
Describes an application to join a group |
Group |
Describes an invitation to a group. |
List |
Lists all outstanding group applications and invitations for an entity. Anyone may call this for any entity, but data will only be returned for the entity or a parent of that entity. To list invitations or applications for a group to check if a player is trying to join, use ListGroupInvitations and ListGroupApplications. |
List |
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 |
EntityWithLineage
Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.
Name | Type | Description |
---|---|---|
Key |
The entity key for the specified entity |
|
Lineage |
Dictionary of entity keys for related entities. Dictionary key is entity type. |
GroupApplication
Describes an application to join a group
Name | Type | Description |
---|---|---|
Entity |
Type of entity that requested membership |
|
Expires |
string |
When the application to join will expire and be deleted |
Group |
ID of the group that the entity requesting membership to |
GroupInvitation
Describes an invitation to a group.
Name | Type | Description |
---|---|---|
Expires |
string |
When the invitation will expire and be deleted |
Group |
The group that the entity invited to |
|
InvitedByEntity |
The entity that created the invitation |
|
InvitedEntity |
The entity that is invited |
|
RoleId |
string |
ID of the role in the group to assign the user to. |
ListMembershipOpportunitiesRequest
Lists all outstanding group applications and invitations for an entity. Anyone may call this for any entity, but data will only be returned for the entity or a parent of that entity. To list invitations or applications for a group to check if a player is trying to join, use ListGroupInvitations and ListGroupApplications.
Name | Type | Description |
---|---|---|
CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
ListMembershipOpportunitiesResponse
Name | Type | Description |
---|---|---|
Applications |
The requested list of group applications. |
|
Invitations |
The requested list of group invitations. |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for