Skip to main content

Function: useProfiles()

useProfiles(params?: { query: QueryOptions<ProfilesResponse>; }): UseQueryResult<ProfilesResponse, Error>

Get profiles

Parameters

ParameterTypeDescription
params?{ query: QueryOptions<ProfilesResponse>; }No required parameters.
params.query?QueryOptions<ProfilesResponse>See Tanstack Query - useQuery options.

Returns

UseQueryResult<ProfilesResponse, Error>

Example

const {
data,
isLoading,
isError,
error,
refetch,
...moreUseQueryResults
} = useProfiles();

See

API Documentation