useUserMemberships for PubNub Chat Components for React

The hook returns a list of channel memberships for a user.

This method doesn't return user's subscriptions. Pagination is handled internally. You can adjust the limit of returned channels on a single call (max/default 100) and call a function returned by the hook to get another page of results.

This hook also sets up a listener that reacts to removals of already fetched channels. Updates and new memberships are not handled due to technical limitations. However, this behavior requires a living subscription to the user getting updated - this should be handled by the components.

User ID / UUID

User ID is also referred to as UUID/uuid in some APIs and server responses but holds the value of the userId parameter you set during initialization.

const [channels, fetchPage, refetchMemberships, total, error, isLoading] = useUserMemberships({
uuid: "user",

return (
<Chat {...{ options }}>
<ChannelList channels={channels} />


includeObjectOptionaln/aOption to include respective additional fields in the response.
→ customFieldsBooleanOptionalfalseOption to fetch custom fields or not.
→ channelFieldsBooleanOptionalfalseOption to include fields for channels metadata.
→ customChannelFieldsBooleanOptionalfalseOption to include custom fields for channels metadata.
filterStringOptionaln/aExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. See the App Context Filtering Language Definition for more details.
sortObjectOptionaln/aKey-value pair of a property to sort by and a sort direction.

Available options are id, name, and updated.

Use asc or desc to specify sort direction, or specify null to take the default sort direction (ascending).

Example: {name: 'asc'}
limitNumberOptional100Number of objects to return in response.

Default is 100 which is also the maximum value.


array[0]ChannelData[]List of returned channels.
array[1]FunctionFunction that can be called to fetch another page of channels.
array[2]FunctionFunction that can be called to completely reset the hook. This can be used in case of expected membership updates.
array[3]NumberTotal number of stored channels.
array[4]ErrorIf there's an error fetching channels, it will be available here.
array[5]BooleanIndicator that the user membership data is still being loaded.
Last updated on
On this page