List Membership Opportunities
Lists all outstanding invitations and group applications for an entity
curl --request POST \
--url https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '{}'import requests
url = "https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities"
payload = {}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"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:59"
},
{
"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:59"
}
],
"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:59"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
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.
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.
Response
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
{
"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:59"
},
{
"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:59"
}
],
"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:59"
}
]
}
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '{}'import requests
url = "https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities"
payload = {}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Group/ListMembershipOpportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"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:59"
},
{
"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:59"
}
],
"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:59"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}