Skip to main content

Overview

Returns a function that fetches the paginated list of accepted connections for any user, identified by userId. Authentication is optional — the endpoint works without a token. When the caller is signed in, any user with a block between them and the caller, in either direction, is excluded from the results. Block filtering requires the moderation bundle. For fetching your own connections, see useFetchConnections.

Usage Example

Parameters

The hook returns a function. That function accepts:
string
required
The ID of the user whose connections to fetch.
number
Page number to fetch. Defaults to 1.
number
Number of results per page. Defaults to 20.
string
Optional search term. Filters the list to connections whose connected user’s username or name contains this text (case-insensitive). When omitted, no filtering is applied.
string
Restricts which field query matches against — username or name. When omitted, query matches either field.

Returns

Returns a PaginatedResponse containing an array of established connections:
EstablishedConnection[]
Array of accepted connection entries.
object
Pagination metadata including page, pageSize, totalPages, totalItems, and hasMore.