> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sublay.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Fetch user by foreign ID
> Fetch a user's public profile by their foreign ID
export const SpaceReputationParams = ({variant = "context", field = "path"}) => {
const isUser = variant === "user";
return <>
Opt-in. Adds a spaceReputation number to each returned user,
scoped to a single space. Requires the reputation bundle.
The reputation total is always present regardless;{" "}
spaceReputation is purely additive and only appears when you
pass this object. This object is the primary form — it
replaces the deprecated flat props below. See the{" "}
Reputation data model for the
full contract.
{isUser ?
Which bucket to read. A space <uuid> reads that
space's bucket; "none" reads the
project-general (space-less) bucket.{" "}
"context" is rejected (400) on this
endpoint — there is no space context to derive. The empty string
and the legacy general / null aliases are
also rejected. Missing buckets read as 0.
:
Which bucket to read. One of: a space <uuid>{" "}
(that space's bucket), "none" (the
project-general, space-less bucket), or{" "}
"context" (the space derived from the
request context — resolved per-row on lists, or the single space on
member/team/conversation surfaces). The empty string and the legacy{" "}
general / null aliases are rejected (400).
Missing buckets read as 0.
}
Only honored when spaceId is an explicit space <uuid>.
When true, spaceReputation is the{" "}
subtree sum — the named space plus all of its
descendant spaces (the root space's own bucket included). Ignored for{" "}
"none"; not allowed with "context".
{isUser ? Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid> or "none" only —{" "}
"context" is rejected (400) on this endpoint.
: Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid>, "none", or{" "}
"context".
}
Deprecated — use{" "}
spaceReputation.includeDescendants instead. The flat form,
only honored alongside an explicit spaceReputationId<uuid>.
;
};
## 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.
If the profile owner has blocked the signed-in caller, this returns `404` — the
same response as a user who does not exist. The reverse is not true: a user
*you* have blocked stays visible, so you keep a way to find and unblock them. Requires the `moderation` bundle.
## Usage Example
```tsx theme={null}
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 ;
}
```
## Parameters
The hook returns a function. That function accepts:
The foreign ID to look up. This is the identifier from your own system that was passed when the user was created or verified.
Optional. Pass `"files"` to populate `avatarFile` and `bannerFile` with full `File` objects.
## Returns
The user's public profile. When `spaceReputation` is requested, it carries an added `spaceReputation` number. See [User data model](/v8/data-models/user) and [Reputation](/v8/data-models/reputation).
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.