Skip to main content
Fetch User
Returns a user’s public profile by their Sublay user ID. Optionally includes associated file records for the avatar and banner.
If the profile owner has blocked the viewer β€” the signed-in user, or the user a service key names in actingUserId β€” 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.

Path Parameters

string
required
The Sublay user ID (UUID).

Query Parameters

Acting user

string
Service key only: the user to read as. The response is exactly what that user’s own access token would get β€” a profile whose owner blocked them returns 404. Leave it out for the anonymous view. A user token always acts as its own user and must not send it, and neither may a request with no credentials (400 user/acting-user-not-allowed).
string
Associations to include, as a comma-separated value or repeated params. The only value is:
  • files β€” the processed avatarFile and bannerFile objects
Matching ignores case. An unknown value returns 400 user/invalid-query.

Space-scoped reputation

This endpoint has no space in context, so the opt-in spaceReputation object accepts a spaceId of a space <uuid> or none only β€” context is rejected (400). It adds a spaceReputation field to each returned user, alongside the always-present reputation total. Requires the reputation bundle. See the Reputation data model.

Response

On success, returns HTTP 200 with the user object:
string
Unique user ID (UUID).
string | null
External identifier linking this user to your system.
string
Project this user belongs to.
string | null
Display name.
string | null
Unique username within the project.
string | null
Avatar image URL.
string | null
Short bio text.
object | null
Public custom key-value data.
number
The user’s overall reputation total (the sum of all their reputation buckets). This is a global lookup with no space in context, so it returns the total only β€” see Reputation for space-scoped reads.
object | null
Processed avatar image with variants. Only present when include=files is requested.
object | null
Processed banner image with variants. Only present when include=files is requested.
string
ISO timestamp of account creation.

Error Responses

Returned for an unknown include value.
A user token, or a request with no credentials, sent actingUserId, even naming its own user. Only a service key names the user it acts as; a user token always acts as its own user.
Returned when a service key names an actingUserId that isn’t a user in this project.

See Also