Skip to main content
GET
Fetch User
Returns a user’s public profile by their Sublay user ID. Optionally includes associated file records for the avatar and banner.

Path Parameters

userId
string
required
The Sublay user ID (UUID).

Query Parameters

include
string
Comma-separated list of associations to include. Pass "files" to include the processed avatarFile and bannerFile objects.

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:
id
string
Unique user ID (UUID).
foreignId
string | null
External identifier linking this user to your system.
projectId
string
Project this user belongs to.
name
string | null
Display name.
username
string | null
Unique username within the project.
avatar
string | null
Avatar image URL.
bio
string | null
Short bio text.
metadata
object | null
Public custom key-value data.
reputation
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.
avatarFile
object | null
Processed avatar image with variants. Only present when include=files is requested.
bannerFile
object | null
Processed banner image with variants. Only present when include=files is requested.
createdAt
string
ISO timestamp of account creation.

Error Responses

See Also