Data ModelsUser

User Object

The User object is the public-facing user model returned by the Replyke API to client apps. It contains identity, profile, and activity-relevant fields but excludes private or admin-only information.

Properties

PropertyTypeDescription
idstringUnique identifier for the user (UUID).
projectIdstringIdentifier of the associated project (UUID).
role"admin" | "editor" | "visitor"Role assigned to the user in the project.
namestring | nullDisplay name of the user.
usernamestring | nullUnique username, if set.
avatarstring | nullURL to the user’s avatar image.
biostring | nullOptional short bio (max 300 characters).
birthdateDate | nullUser’s birthdate.
metadataRecord<string, any>Public metadata, available in shared content (max size: 10KB).
reputationnumberActivity-based score managed by Replyke.
createdAtDateTimestamp when the user was created.

AuthUser Object

The AuthUser object represents the authenticated user’s own profile data delivered to their client. It includes both public and some private fields that are only accessible to the user themselves, plus suspension history.

Properties

PropertyTypeDescription
idstringUnique identifier for the user (UUID).
projectIdstringIdentifier of the associated project (UUID).
foreignIdstring | nullOptional external or static ID for mapping users from another system.
role"admin" | "editor" | "visitor"Role assigned to the user in the project.
emailstring | nullUser’s email address (only visible to themselves).
namestring | nullDisplay name of the user.
usernamestring | nullUnique username, if set.
avatarstring | nullURL to the user’s avatar image.
biostring | nullOptional short bio (max 300 characters).
birthdateDate | nullUser’s birthdate.
metadataRecord<string, any>Public metadata, available in shared content (max size: 10KB).
reputationnumberActivity-based score managed by Replyke.
isVerifiedbooleanWhether the user is verified.
isActivebooleanWhether the account is currently active.
lastActiveDateTimestamp of most recent user activity.
suspensions{ reason: string | null, startDate: Date, endDate: Date | null }[]Array of suspension records with reason and duration.

UserFull Object

The UserFull object is an internal model used within Replyke’s administrative interfaces. It contains the full user record, including sensitive, private, or backoffice-only fields.

Properties

PropertyTypeDescription
idstringUnique identifier for the user (UUID).
projectIdstringIdentifier of the associated project (UUID).
foreignIdstring | nullOptional external or static ID for mapping users from another system.
role"admin" | "editor" | "visitor"Role assigned to the user in the project.
emailstring | nullUser’s email address.
namestring | nullDisplay name.
usernamestring | nullUnique username.
avatarstring | nullAvatar image URL.
biostring | nullBio (up to 300 characters).
birthdateDate | nullDate of birth.
location{ type: "Point", coordinates: [number, number] } | nullOptional user location in GeoJSON format.
metadataRecord<string, any>Public, sharable metadata (max 10KB).
secureMetadataRecord<string, any>Private metadata, excluded from shared views.
reputationnumberSystem-managed score based on participation.
isVerifiedbooleanWhether the user is verified.
isActivebooleanWhether the account is currently active.
lastActiveDateTimestamp of most recent user activity.
suspension{ isSuspended: boolean, reason: string | null, startDate: Date | null, endDate: Date | null }Suspension status and duration.
createdAtDateCreation timestamp.
updatedAtDateLast updated timestamp.
deletedAtDate | nullDeletion timestamp, if applicable.

Summary of Differences

FieldIncluded in User?Included in AuthUser?Included in UserFull?Notes
foreignIdExternal mapping ID — excluded from public view.
emailSensitive — only shown to user themselves or admins.
locationGeographic data — admin use only.
secureMetadataInternal use only.
isVerifiedPlatform-level detail.
isActiveAccount status — shown to user themselves.
lastActiveActivity tracking.
suspensionsSuspension history — specific to AuthUser.
suspensionCurrent suspension status — admin view only.
updatedAt, deletedAtFull auditing data only shown in admin dashboard.