Documentation

ListMembershipOpportunities

Lists all outstanding invitations and group applications for an entity

Request Details

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.

ListMembershipOpportunitiesRequest
Request Properties
Entity EntityKey

The entity to perform this action on.

POST https://{{TitleID}}.playfabapi.com/Group/ListMembershipOpportunities
    Content-Type: application/json
{}
        

Response Details

ListMembershipOpportunitiesResponse
Result Properties
Applications List<GroupApplication>

The requested list of group applications.

Invitations List<GroupInvitation>

The requested list of group invitations.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Invitations": [
      {
        "InvitedEntity": {
          "Key": {
            "Id": "90901000",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          },
          "Lineage": {
            "master_player_account": {
              "Id": "800DED92",
              "Type": "master_player_account",
              "TypeString": "master_player_account"
            }
          }
        },
        "Group": {
          "Id": "ABC1234ABC"
        },
        "InvitedByEntity": {
          "Key": {
            "Id": "9023AFF3",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          },
          "Lineage": {
            "master_player_account": {
              "Id": "366AD424",
              "Type": "master_player_account",
              "TypeString": "master_player_account"
            }
          }
        },
        "RoleId": "awesomepeople",
        "Expires": "2017-12-31T11:59:59Z"
      },
      {
        "InvitedEntity": {
          "Key": {
            "Id": "90901000",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          },
          "Lineage": {
            "master_player_account": {
              "Id": "800DED92",
              "Type": "master_player_account",
              "TypeString": "master_player_account"
            }
          }
        },
        "Group": {
          "Id": "ABC1234ABC"
        },
        "InvitedByEntity": {
          "Key": {
            "Id": "9023AFF3",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          },
          "Lineage": {
            "master_player_account": {
              "Id": "366AD424",
              "Type": "master_player_account",
              "TypeString": "master_player_account"
            }
          }
        },
        "RoleId": "members",
        "Expires": "2017-12-31T11:59:59Z"
      }
    ],
    "Applications": [
      {
        "Group": {
          "Id": "ABC1234ABC"
        },
        "Entity": {
          "Key": {
            "Id": "90901000",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          },
          "Lineage": {
            "master_player_account": {
              "Id": "800DED92",
              "Type": "master_player_account",
              "TypeString": "master_player_account"
            }
          }
        },
        "Expires": "2017-12-31T11:59:59Z"
      }
    ]
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089