> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PFLeaderboardsGetFriendLeaderboardForEntityRequest

> Reference for the PFLeaderboardsGetFriendLeaderboardForEntityRequest struct in the PlayFab Services C API, used to query a friend leaderboard.

PFLeaderboardsGetFriendLeaderboardForEntityRequest data model.

## Syntax

```cpp theme={null}
typedef struct PFLeaderboardsGetFriendLeaderboardForEntityRequest {  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    PFEntityKey const* entity;  
    PFExternalFriendSources const* externalFriendSources;  
    const char* leaderboardName;  
    uint32_t const* version;  
    const char* xboxToken;  
} PFLeaderboardsGetFriendLeaderboardForEntityRequest;  
```

### Members

**`customTags`**   [PFStringDictionaryEntry](/services/playfab/api-references/c/pftypes/structs/pfstringdictionaryentry) const\*<br />*may be nullptr*

(Optional) The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

**`customTagsCount`**   uint32\_t

Count of customTags

**`entity`**   [PFEntityKey](/services/playfab/api-references/c/pftypes/structs/pfentitykey-c) const\*<br />*may be nullptr*

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

**`externalFriendSources`**   [PFExternalFriendSources](/services/playfab/api-references/c/pfleaderboardstypes/enums/pfexternalfriendsources) const\*<br />*may be nullptr*

(Optional) Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.

**`leaderboardName`**   const char\*<br />*is null-terminated*

Name of the leaderboard.

**`version`**   uint32\_t const\*<br />*may be nullptr*

(Optional) Optional version of the leaderboard, defaults to current version.

**`xboxToken`**   const char\*<br />*is null-terminated*

(Optional) XBOX token if XBOX friends should be included. Requires XBOX be configured on PlayFab.

## Requirements

**Header:** PFLeaderboardsTypes.h

## See also

[PFLeaderboardsTypes members](/services/playfab/api-references/c/pfleaderboardstypes/pfleaderboardstypes_members)


## Related topics

- [PFLeaderboardsGetFriendLeaderboardForEntityAsync](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetfriendleaderboardforentityasync.md)
- [Services C API overview - PFLeaderboardsTypes.h](/services/playfab/api-references/c/pfleaderboardstypes/pfleaderboardstypes_members.md)
- [PFLeaderboardsGetFriendLeaderboardForEntityGetResult](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetfriendleaderboardforentitygetresult.md)
- [PFLeaderboardsGetFriendLeaderboardForEntityGetResultSize](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetfriendleaderboardforentitygetresultsize.md)
- [PFLeaderboardsGetLeaderboardForEntitiesRequest](/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetleaderboardforentitiesrequest.md)