Groups - List Membership Opportunities

  • Reference
Service:
Groups
API Version:
240412

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

EntityKey

The optional entity to perform this action on. Defaults to the currently logged in entity.

Responses

Name Type Description
200 OK

ListMembershipOpportunitiesResponse

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.
EntityWithLineage

Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.
GroupApplication

Describes an application to join a group
GroupInvitation

Describes an invitation to a group.
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.
ListMembershipOpportunitiesResponse

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

EntityKey

The entity key for the specified entity
Lineage

EntityKey

Dictionary of entity keys for related entities. Dictionary key is entity type.

GroupApplication

Describes an application to join a group

Name Type Description
Entity

EntityWithLineage

Type of entity that requested membership
Expires

string

When the application to join will expire and be deleted
Group

EntityKey

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

EntityKey

The group that the entity invited to
InvitedByEntity

EntityWithLineage

The entity that created the invitation
InvitedEntity

EntityWithLineage

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

EntityKey

The optional entity to perform this action on. Defaults to the currently logged in entity.

ListMembershipOpportunitiesResponse

Name Type Description
Applications

GroupApplication[]

The requested list of group applications.
Invitations

GroupInvitation[]

The requested list of group invitations.