BETTER-AUTH. UI
Queries

useListDeviceSessions

Retrieve the device sessions for the multi-session account switcher.

Powers the multi-session account switcher — each entry represents a session currently signed in on this device.

Keyed per-user; waits for the active session before firing.

Usage

import {
  type MultiSessionAuthClient,
  useAuth,
  useListDeviceSessions
} from "@better-auth-ui/react"

const { authClient } = useAuth()
const { data: deviceSessions } = useListDeviceSessions(
  authClient as MultiSessionAuthClient
)

// With React Query options
const { data: deviceSessions } = useListDeviceSessions(
  authClient as MultiSessionAuthClient,
  { refetchOnMount: false }
)

useListDeviceSessions requires the Better Auth multiSession plugin. Cast authClient to MultiSessionAuthClient so TypeScript picks up the plugin-extended method signature.

Options factory

import { listDeviceSessionsOptions } from "@better-auth-ui/react"
import { useQuery } from "@tanstack/react-query"

const { data: deviceSessions } = useQuery(
  listDeviceSessionsOptions(authClient, userId)
)

Invalidation

import { listDeviceSessionsOptions } from "@better-auth-ui/react"

queryClient.invalidateQueries({
  queryKey: listDeviceSessionsOptions(authClient, userId).queryKey
})

Params

Prop

Type

Last updated on

On this page