Fetch user by foreign ID

Overview

useFetchUserByForeignId returns a function that fetches a user’s public profile using their foreignId — the ID from your own system that was associated with this user during authentication. Use this when you have your own user ID and need to look up the corresponding Sublay user profile.

Usage Example

import { useFetchUserByForeignId } from "@sublay/react-js";

function UserCard({ myUserId }: { myUserId: string }) {
  const fetchUser = useFetchUserByForeignId();

  const load = async () => {
    const user = await fetchUser({ foreignId: myUserId });
    console.log(user);
  };

  return <button onClick={load}>Load Profile</button>;
}

Parameters

The hook returns a function. That function accepts:

foreignId

string

required

The foreign ID to look up. This is the identifier from your own system that was passed when the user was created or verified.

include

string | string[]

Optional. Pass "files" to populate avatarFile and bannerFile with full File objects.

Returns

User

The user’s public profile. When spaceReputation is requested, it carries an added spaceReputation number. See User data model and Reputation.

Overview

Auth Hooks

Current User

User Profiles

Entities

Entity Lists

Spaces

Spaces — Rules

Space Lists

Events

Comments

Reactions

Follows

Connections

Collections

App Notifications

Push Notifications

Chat — Conversations

Chat — Messages

Chat — Core

Search

Reports

Storage

Crypto

Project

Custom Tables

Overview

Usage Example

Parameters

Returns

​Overview

​Usage Example

​Parameters

​Returns

Overview

Usage Example

Parameters

Returns