Documentation

ListGroupInvitations

Lists all outstanding invitations for a group

Request Details

Lists all outstanding invitations for a group. Returns a list of entities that have been invited, as well as when the invitation will expire. To get the group invitations for a specific entity, use ListMembershipOpportunities.

ListGroupInvitationsRequest
Request Properties
Group (required) EntityKey

The identifier of the group

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

Response Details

ListGroupInvitationsResponse
Result Properties
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"
      }
    ]
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089