Variable getUsersUseridFriendsSearch`Const`

getUsersUseridFriendsSearch: EndpointGeneric<{
    cursor: undefined | string;
    limit: undefined | number;
    query: undefined | string;
    userId: number;
}, {
    HasMore: boolean;
    NextCursor: string;
    PageItems: {
        hasVerifiedBadge: boolean;
        id: number;
    }[];
    PreviousCursor: string;
}, any> = ...

Api

GET https://friends.roblox.com/v1/users/:userId/friends/search

Summary

Search for friends by name using a text query.

Param: userId

The user Id to get the friends for.

Param: query

The string to search names of friends for.

Param: cursor

The paging cursor for the previous or next page.

Param: limit

The number of results per request.