> ## Documentation Index
> Fetch the complete documentation index at: https://docs.replyke.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Users
> Fetch and update user profiles, check usernames, and query follow and connection graphs
The `users` module provides server-side access to user profiles, social graph data (follows and connections), and username availability. All operations use your project API key and do not require a user access token.
***
### fetchUserById
Fetches a user profile by their internal Replyke user ID.
```typescript theme={null}
const user = await replyke.users.fetchUserById({ userId: "usr_abc123" });
```
The Replyke user ID.
**Returns** — `Promise`
***
### fetchUserByForeignId
Fetches a user profile by your application's own user identifier. Optionally creates the user if not found.
```typescript theme={null}
const user = await replyke.users.fetchUserByForeignId({
foreignId: "external-user-42",
createIfNotFound: true,
name: "Bob Smith",
username: "bob",
});
```
Your application's user identifier.
When `true`, creates the user with the provided profile fields if no match is found. Defaults to `false`.
Display name — used only when creating a new user.
Username — used only when creating a new user.
Avatar URL — used only when creating a new user.
Bio text — used only when creating a new user.
Public metadata — used only when creating a new user.
Secure metadata (not exposed to the client) — used only when creating a new user.
**Returns** — `Promise`
***
### fetchUserByUsername
Fetches a user profile by their username.
```typescript theme={null}
const user = await replyke.users.fetchUserByUsername({ username: "alice" });
```
The user's unique username.
**Returns** — `Promise`
***
### updateUser
Updates a user's profile fields.
```typescript theme={null}
const updatedUser = await replyke.users.updateUser({
userId: "usr_abc123",
name: "Alice Updated",
bio: "New bio",
avatar: "https://cdn.example.com/avatar.jpg",
location: { latitude: 37.7749, longitude: -122.4194 },
});
```
The Replyke user ID to update.
New display name.
New username. Must be available.
New bio text.
New avatar URL.
Updated public metadata. Merged with existing metadata.
ISO 8601 date string for the user's birthdate.
Geographic location `{ latitude: number; longitude: number }`.
**Returns** — `Promise`
***
### fetchUserSuggestions
Returns users whose name or username matches a partial query string. Useful for mention autocomplete on the server.
```typescript theme={null}
const users = await replyke.users.fetchUserSuggestions({
query: "ali",
limit: 10,
});
```
Partial name or username to search for.
Maximum number of results to return.
**Returns** — `Promise`
***
### checkUsernameAvailability
Checks whether a username is available for registration.
```typescript theme={null}
const { available } = await replyke.users.checkUsernameAvailability({
username: "alice",
});
```
The username to check.
**Returns** — `Promise<{ available: boolean }>`
***
### fetchFollowersByUserId
Returns a paginated list of users following the specified user.
```typescript theme={null}
const { data, metadata } = await replyke.users.fetchFollowersByUserId({
userId: "usr_abc123",
page: 1,
limit: 20,
});
```
The Replyke user ID.
Page number (1-indexed). Defaults to `1`.
Results per page. Defaults to `20`.
**Returns** — `Promise>`
***
### fetchFollowersCountByUserId
Returns the total number of followers for a user.
```typescript theme={null}
const { count } = await replyke.users.fetchFollowersCountByUserId({
userId: "usr_abc123",
});
```
The Replyke user ID.
**Returns** — `Promise<{ count: number }>`
***
### fetchFollowingByUserId
Returns a paginated list of users that the specified user is following.
```typescript theme={null}
const { data, metadata } = await replyke.users.fetchFollowingByUserId({
userId: "usr_abc123",
page: 1,
limit: 20,
});
```
The Replyke user ID.
Page number (1-indexed). Defaults to `1`.
Results per page. Defaults to `20`.
**Returns** — `Promise>`
***
### fetchFollowingCountByUserId
Returns the number of users the specified user is following.
```typescript theme={null}
const { count } = await replyke.users.fetchFollowingCountByUserId({
userId: "usr_abc123",
});
```
The Replyke user ID.
**Returns** — `Promise<{ count: number }>`
***
### fetchConnectionsByUserId
Returns a paginated list of established mutual connections for a user.
```typescript theme={null}
const { data, metadata } = await replyke.users.fetchConnectionsByUserId({
userId: "usr_abc123",
page: 1,
limit: 20,
});
```
The Replyke user ID.
Page number (1-indexed). Defaults to `1`.
Results per page. Defaults to `20`.
**Returns** — `Promise>`
***
### fetchConnectionsCountByUserId
Returns the number of established connections for a user.
```typescript theme={null}
const { count } = await replyke.users.fetchConnectionsCountByUserId({
userId: "usr_abc123",
});
```
The Replyke user ID.
**Returns** — `Promise<{ count: number }>`