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

# PFFriendsClientGetFriendsListAsync

> Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also.

Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.

## Syntax

```cpp theme={null}
HRESULT PFFriendsClientGetFriendsListAsync(  
    PFEntityHandle entityHandle,  
    const PFFriendsClientGetFriendsListRequest* request,  
    XAsyncBlock* async  
)  
```

### Parameters

**`entityHandle`**   PFEntityHandle

PFEntityHandle to use for authentication.

**`request`**   [PFFriendsClientGetFriendsListRequest\*](/services/playfab/api-references/c/pffriendstypes/structs/pffriendsclientgetfriendslistrequest)

Populated request object.

**`async`**   XAsyncBlock\*<br />*Inout*

XAsyncBlock for the async operation.

### Return value

Type: HRESULT

Result code for this API operation.

## Remarks

This API is available on all platforms. See also ClientAddFriendAsync, ClientGetPlayerProfileAsync, ClientRemoveFriendAsync. When the asynchronous task is complete, call [PFFriendsClientGetFriendsListGetResultSize](/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistgetresultsize) and [PFFriendsClientGetFriendsListGetResult](/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistgetresult) to get the result.

## Requirements

**Header:** PFFriends.h

## See also

[PFFriends members](/services/playfab/api-references/c/pffriends/pffriends_members)


## Related topics

- [PFFriendsClientGetFriendsListGetResult](/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistgetresult.md)
- [Services C API overview - PFFriends.h](/services/playfab/api-references/c/pffriends/pffriends_members.md)
- [PFFriendsClientAddFriendAsync](/services/playfab/api-references/c/pffriends/functions/pffriendsclientaddfriendasync.md)
- [PFFriendsClientSetFriendTagsAsync](/services/playfab/api-references/c/pffriends/functions/pffriendsclientsetfriendtagsasync.md)
- [PFFriendsClientGetFriendsListGetResultSize](/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistgetresultsize.md)