Users

A user is a Micup account. Another account sees the partial user object, and the owner sees the user object. Account mutation lives on Current user.

Every route on this page takes a user session token or a bot token. An OAuth2 bearer credential is rejected with 403 ACCESS_DENIED.

Object	Purpose
Partial user	Public account representation embedded everywhere
Name style	Plus name font and colours
User	Private owner representation
User settings	Account-wide settings record
Full user profile	Profile read for one target account

Partial user object

The public account representation embedded by messages, relationships, guild members, and applications.

Structure

Field	Type	Description
id	snowflake	The snowflake that identifies the account
username	string	The account username (1-32 ASCII letters, digits, or underscores)
discriminator	string	The account discriminator, four decimal digits with leading zeroes
identity_version?	string	Decimal, monotonic generation of the username and discriminator
global_name	?string	The display name of the account, or null when none is set
avatar1	?string	The image hash of the account avatar, or null when none is set
avatar_color	?integer	The packed 24-bit RGB colour derived from the stored avatar, or null
bot?	boolean	Whether the account is a bot, omitted when false
system?	boolean	Whether the account is a Micup system account, omitted when false
flags	integer	Public user flags
mention_flags?	integer	Reply mention preference, omitted when the account has no preference
avatar_decoration_data	?cosmetic asset data object	The avatar decoration the account wears, or null when none
avatar_ultra_data	?cosmetic asset data object	The ultra decoration the account wears, or null when none
nameplate_data	?cosmetic asset data object	The nameplate the account wears, or null when none
name_style	?name style object	The name font and colours, or null when none is set or Plus is not active

¹ An animated avatar hash has the a_ prefix, and the prefix is removed while the account has no animated avatar entitlement

A cached username or discriminator is replaced only by an equal or newer identity_version. Other profile fields merge whatever the generation.

Example

{
  "id": "1501314428688998182",
  "username": "aria",
  "discriminator": "0042",
  "global_name": "Aria",
  "avatar": "a_2f1c9d7be4a350c8",
  "avatar_color": 5793266,
  "flags": 8
}

A deleted account keeps a renderable shape

A completed deletion returns the username DeletedUser, the discriminator 0000, the global name Deleted User, null avatar and avatar_color, flags of 0, and no mention_flags. The bot field keeps its account value.

Substituted values appear only when deletion completes

A system account never receives the deleted representation. An account only scheduled for deletion keeps its ordinary representation throughout the grace period.

An instance without tags

On an instance whose tag_style feature is none, a selected human username is unique and has the discriminator 0000. Micup displays it as @alex. During username migration, people who have not selected a name keep their nonzero discriminator and display as Alex#4821, even though the instance uses none. Bot accounts keep their random discriminators and display them. A tag such as alex#4821 resolves only to a legacy account; it never resolves to a person who has selected @alex. Names do not change account IDs, mentions or profile links. Micup sign-in remains email-only.

Public user flags

flags holds the publicly visible subset of the account’s stored flags. STAFF is also removed from flags while the account has the stored STAFF_HIDDEN flag.

Value	Name	Description
1 << 0	STAFF	Account is a staff member
1 << 2	PARTNER	Account is a partner
1 << 3	BUG_HUNTER	Account is a bug hunter
1 << 4	FRIENDLY_BOT	Bot accepts friend requests from users
1 << 5	FRIENDLY_BOT_MANUAL_APPROVAL	Bot requires manual approval for friend requests
1 << 6	SPAMMER	Account is flagged as a spammer
1 << 29	VERIFIED	Account is verified by the instance
1 << 26	PREMIUM_BADGE_WHITE	Lasting package badge: the largest paid premium package the account bought is 1 month
1 << 27	PREMIUM_BADGE_BLUE	Lasting package badge: the largest paid premium package the account bought is 3 months
1 << 28	PREMIUM_BADGE_GOLD	Lasting package badge: the largest paid premium package the account bought is 12 months
1 << 30	PREMIUM_BADGE	Account has premium and has not hidden its badge. Computed every time the user is read, never stored; it cannot be set.

Every reader sees PREMIUM_BADGE, bots and OAuth2 applications included; the account removes it by setting premium_badge_hidden on Current user.

At most one package badge flag is set. It stays after premium ends, so it can appear without PREMIUM_BADGE; hiding the premium badge, disabling premium perks, a bot and a deleted account remove it too. Like PREMIUM_BADGE, it is computed on every read and cannot be set. Premium from a gift code, an admin grant, a referral reward or a trial adds no package badge, and lifetime premium never has one. An admin premium end removes it.

Reply mention preferences

The account-wide preference applied when another account replies to one of this account’s messages. mention_flags is exactly one of the values below. It is omitted from a serialised user while the stored value is NO_PREFERENCE.

Value	Name	Description
0	NO_PREFERENCE	The sender chooses whether each reply mentions this account, with no warning when the mention is toggled
1	PREFER_MENTION	Replies mention this account by default, and the sender is warned when they disable the mention
2	PREFER_NO_MENTION	Replies omit the mention by default, and the sender is warned when they enable it

A guild member has the same enumeration in its own mention_flags, where NO_PREFERENCE inherits the account-wide value.

Name style object

The Plus name font and colours, set through Modify current user. The stored style stays when Plus ends and shows again when it returns. It is null on a hidden profile, a deleted account, and a bot.

Structure

Field	Type	Description
font_id	integer	Name style font
colors	array[integer]	One packed 24-bit RGB colour for a solid name, or two for a gradient

Name style fonts

A font ID is stable and never reused.

Value	Name	Description
1	BALOO	Baloo 2
2	PLAYPEN	Playpen Sans
3	PACIFICO	Pacifico
4	CAVEAT	Caveat
5	PIXELIFY	Pixelify Sans
6	PRESSSTART	Press Start 2P
7	VT323	VT323
8	AUDIOWIDE	Audiowide
9	GRENZE	Grenze Gotisch
10	NEWROCKER	New Rocker
11	BUNGEE	Bungee
12	RIGHTEOUS	Righteous

User object

During Micup username migration, the owner-only username_state is legacy, selected, or reselect_required. It is absent from public users, members, presence, search and OAuth2 identity responses. GET /users/@me/username also returns state, changeAvailableAt (an ISO timestamp or null) and freeChangeAvailable. The first selection and one subsequent change have no waiting period; further changes require 14 days. POST /users/@me/username-prompt returns show; the server allows at most one prompt per person per Istanbul day.

After the migration deadline, an unselected person must choose a name before creating messages, reactions, friendships, guilds or DMs, joining guilds, adding bots or joining/moving voice. USERNAME_SELECTION_REQUIRED carries the same requirement for HTTP and voice. Sign-out, email verification, sudo/MFA, password recovery, account deletion, data export, settings, support, blocking/reporting and reading remain available. Suspended accounts are not forced to choose a name until their suspension ends.

The private representation of the current account, returned by Get current user and by every operation that changes the account. It extends the partial user object.

Structure

Field	Type	Description
id	snowflake	The snowflake that identifies the account
username	string	The account username (1-32 ASCII letters, digits, or underscores)
discriminator	string	The account discriminator, four decimal digits with leading zeroes
identity_version?	string	Decimal, monotonic identity generation, as on the partial user object
username_state?	string	Owner-only selection state, as returned by Get username status
global_name	?string	The display name of the account, or null when none is set
avatar1	?string	The image hash of the account avatar, or null when none is set
avatar_color	?integer	The packed 24-bit RGB colour derived from the stored avatar, or null
bot?	boolean	Whether the account is a bot, omitted when false
system?	boolean	Whether the account is a Micup system account, omitted when false
flags	integer	Public user flags
mention_flags?	integer	Reply mention preference, omitted when the account has no preference
avatar_decoration_data	?cosmetic asset data object	The avatar decoration the account wears, or null when none
avatar_ultra_data	?cosmetic asset data object	The ultra decoration the account wears, or null when none
nameplate_data	?cosmetic asset data object	The nameplate the account wears, or null when none
name_style	?name style object	The name font and colours, or null when none is set or Plus is not active
is_staff	boolean	Whether the account has the staff flag, including when that flag is hidden from flags
acls2 3	array[string]	The Admin access control entries held by the account
traits3 4	array[string]	The account traits, in sorted order
email5	?string	The account email address, or null when none exists
email_bounced?3	boolean	Whether the mail provider marked the current email as bounced
has_verified_phone	boolean	Deprecated. Always false
bio	?string	The profile biography, or null when none is set
pronouns	?string	The profile pronouns, or null when none are set
accent_color	?integer	The profile accent colour as packed 24-bit RGB, or null when none is set
theme_colors	?array[integer]	The profile card gradient, top then bottom colour, or null when none is set or Plus is not active
timezone?6	?string	The IANA timezone identifier stored for the account, or null when none is set
timezone_privacy_flags?6	integer	Profile field privacy flags applied to the profile timezone
banner7	?string	The image hash of the profile banner, or null when none is set or the entitlement is missing
banner_color	?integer	The packed 24-bit RGB colour derived from the stored banner, or null
mfa_enabled3 8	boolean	Whether any authenticator is configured
authenticator_types?3 8	array[integer]	Authenticator types configured for the account
verified5	boolean	Whether the account email is verified
account_limited?	boolean	Whether the account is limited
premium_type9	?integer	Premium type
premium_since3 9	?ISO8601 timestamp	The time premium was first activated, or null
premium_until3 10	?ISO8601 timestamp	The end of current premium access, or null when no premium period is stored
premium_will_cancel3	boolean	Whether subscription premium will cancel at the billing boundary
premium_billing_cycle3	?string	The premium billing cycle, or null
premium_lifetime_sequence3	?integer	The lifetime premium sequence, or null
premium_grace_ends_at11	?ISO8601 timestamp	The end of grace access after premium_until passes, or null when no grace is recorded
premium_discriminator12	boolean	Whether the current discriminator was selected under a premium entitlement
premium_badge_hidden3	boolean	Whether the premium badge is hidden from the public profile
premium_badge_masked3	boolean	Whether a lifetime badge is presented as an ordinary subscription badge
premium_badge_timestamp_hidden3	boolean	Whether the premium activation time is hidden from the public profile
premium_badge_sequence_hidden3	boolean	Whether the lifetime sequence is hidden from the public profile
premium_purchase_disabled3	boolean	Whether premium purchasing is disabled for the account
premium_enabled_override3	boolean	Whether an administrative override grants premium entitlements
premium_perks_disabled3	boolean	Whether premium entitlements are suspended for the account
password_last_changed_at3	?ISO8601 timestamp	The time of the most recent password change, or null
last_voice_activity_sharing_change_at13	?ISO8601 timestamp	The time of the most recent bulk voice activity sharing change, or null
required_actions3	array[string]	Deprecated. Always empty
nsfw_allowed3 14	boolean	Whether the account can access age-restricted content
public_profile_allowed?20	boolean	Whether the account may choose the EVERYONE profile privacy level
has_dismissed_premium_onboarding3 15	boolean	Whether premium onboarding was dismissed
has_ever_purchased3	boolean	Whether the account has completed a purchase
has_unread_gift_inventory3 16	boolean	Whether the gift inventory has unread items
unread_gift_inventory_count3 16	integer	The number of unread gift inventory items
pending_bulk_message_deletion3	?pending bulk message deletion object	The message deletion the account scheduled for itself, or null when none is pending
age_verified_adult?	boolean	Whether adult age verification is complete, omitted when false
terms_agreed_at	?ISO8601 timestamp	The time of the most recent terms acceptance, or null
privacy_agreed_at	?ISO8601 timestamp	The time of the most recent privacy policy acceptance, or null

¹ An animated avatar hash has the a_ prefix, and the prefix is removed while the account has no animated avatar entitlement

² The array is empty for an account with no Admin access, and it is replaced in full by Set user ACLs. It is independent of is_staff

³ The field is neutralised for an OAuth2 bearer credential as described below

⁴ The value premium is present exactly when premium entitlements are active, regardless of the stored trait set, and every other stored trait is returned sorted

⁵ For an OAuth2 bearer credential without the email scope, email is null

⁶ This server version writes the pair for every account

⁷ The banner hash is not returned at all while the account lacks the animated banner entitlement, which every profile banner requires

⁸ mfa_enabled is true exactly when at least one authenticator is configured. An account with no authenticator reports authenticator_types as an empty array, and only a bearer read drops the field

⁹ The value is forced to 0 and premium_since is forced to null while premium entitlements are not active

¹⁰ premium_until is the later of the subscription end and any stacked gift extension. Micup reports it even when premium entitlements are no longer active

¹¹ After premium_until passes, premium entitlements stay active until this time. While the value is null, they stay active for 3 days after premium_until

¹² The flag is set when the account changes its username or discriminator while holding non-lifetime premium, and after that premium access ends, Micup replaces the discriminator with a newly generated one the next time the account starts a Gateway session. An instance with the none tag style skips the replacement and keeps 0000

¹³ The value drives the 24-hour cooldown on changing the default voice activity sharing state

¹⁴ A bot account is always permitted, and a user account is permitted only when its recorded date of birth places it at 18 years or older

¹⁵ The value is false while premium entitlements are not active, even when a dismissal was recorded earlier

¹⁶ Reports whether unread gifts exist and how many. An account with no gifts reports false and 0

²⁰ True only when the account’s recorded date of birth places it at 16 years or older. An account without a date of birth is never permitted

A bearer read returns zero values

acls, traits, and required_actions become empty arrays. email_bounced and authenticator_types are dropped. Every field marked ³ above that is a boolean becomes false, every timestamp or nullable field becomes null, and unread_gift_inventory_count becomes 0.

Pending bulk message deletion object

A scheduled deletion of every message the account has sent. The field is this object only while the deletion requested through Request bulk message deletion is still waiting to run.

Structure

Field	Type	Description
scheduled_at	ISO8601 timestamp	The time at which the deletion runs
channel_count1	integer	The number of channels holding a message that will be deleted
message_count1	integer	The number of messages that will be deleted

¹ Both counts are computed when the deletion is scheduled and are not recomputed while it waits

Authenticator types

Value	Name	Description
0	TOTP	Time-based one-time password authenticator
2	WEBAUTHN	WebAuthn authenticator

The value 1 is unassigned. Any stored authenticator value outside this registry is excluded from authenticator_types.

WEBAUTHN is present only while the account chose passkeys as a second factor through Set WebAuthn two-factor authentication. Registering a credential does not add it, so an account can hold passkeys without the type.

Premium types

Value	Name	Description
0	NONE	No premium subscription
1	SUBSCRIPTION	Active premium subscription
2	LIFETIME	Lifetime premium subscription

Account limitation

An account is limited while its user object reports account_limited as true. A limited account can still read, join voice, change its own settings, and manage its sessions. The operations below return 403 ACCOUNT_LIMITED, and the error message tells the user to check their email.

• Create message and Modify message in any channel except the account’s personal notes
• Crosspost message
• Add own reaction
• Create webhook
• Accept invite and Join discovery guild, unless the account is already a member
• Create guild
• Creating a group direct message through Create private channel, and Add group direct message recipient
• Changing a profile field through Modify current user or Modify current guild member
• Setting a custom status through Modify current user settings or a presence update
• Initiate connection, Verify and create connection, and Start Bluesky authorisation
• Upload entrance sound and Set entrance sound selection

Profile field privacy flags

A field whose flags value is 0 is visible to nobody, including on the owner’s own profile read.

Value	Name	Description
1 << 0	EVERYONE	Anyone permitted to view the full profile can see the field
1 << 1	FRIENDS	Friends can see the field
1 << 2	MUTUAL_GUILDS	Members of a mutual guild can see the field

User settings object

The complete account-wide settings record, with one field per setting. synced_preferences holds a base64-encoded Protobuf snapshot defined by the user settings Protobuf reference. Micup stores that snapshot for clients and never interprets it.

The user settings update object lists the fields an update accepts and what each supplied or omitted field does to the stored value. Both settings operations return this object, and so do Ready and User Settings Update. Every field below is always present.

Structure

Field	Type	Description
status	string	Presence status
status_resets_at	?ISO8601 timestamp	The time at which the scheduled status reset applies, or null
status_resets_to	?string	Presence status applied by the scheduled reset, or null
theme	string	Theme value
locale	string	The interface locale
restricted_guilds1	array[snowflake]	The guilds where member direct messages are restricted
bot_restricted_guilds1	array[snowflake]	The guilds where bot direct messages are restricted
default_guilds_restricted	boolean	Whether newly joined guilds restrict member direct messages
bot_default_guilds_restricted	boolean	Whether newly joined guilds restrict bot direct messages
inline_attachment_media	boolean	Whether attachment media is rendered inline
inline_embed_media	boolean	Whether embed media is rendered inline
gif_auto_play	boolean	Whether GIF media plays automatically
render_embeds	boolean	Whether message embeds are rendered
render_reactions	boolean	Whether message reactions are rendered
animate_emoji	boolean	Whether custom emoji animate
animate_stickers	integer	Sticker animation setting
render_spoilers	integer	Spoiler rendering setting
message_display_compact	boolean	Whether messages use compact display
friend_source_flags	integer	Friend source flags
incoming_call_flags	integer	Incoming call flags
group_dm_add_permission_flags	integer	Group DM add permission flags
guild_folders2	array[guild folder object]	The user-owned guild sidebar layout
custom_status	?custom status object	The current custom status, or null when none is set
afk_timeout	integer	The idle time in seconds before the account is presented as away
time_format	integer	Time format setting
developer_mode	boolean	Whether developer mode is enabled
trusted_domains3	array[string]	The external link domains the account trusts
default_hide_muted_channels	boolean	Whether newly joined guilds hide muted channels
sensitive_content_friend_dm_filter	integer	Sensitive media filter for friend direct messages
sensitive_content_non_friend_dm_filter	integer	Sensitive media filter for non-friend direct messages
sensitive_content_guild_filter	integer	Guild sensitive media filter
suppress_unprivileged_self_mentions4	boolean	Whether direct and reply mentions from unprivileged users are suppressed
suppress_unprivileged_self_mentions_bypass_user_ids4 5	array[snowflake]	The users exempt from mention suppression
staff_dm_access_user_ids4 5	array[snowflake]	The users granted staff direct message access
synced_preferences6	string	The base64-encoded synced preferences message
profile_privacy	integer	Profile privacy level
game_activity_visibility8	string	Effective audience: off, friends (friends only), or everyone (friends and shared guild members)
game_activity_policy_revision	string	Read-only decimal revision used by the server to protect concurrent game sharing policy writes (default "0")
game_activity_eligible	boolean	Whether the account may share its current game: a human account with a valid date of birth of 15 years or older
game_activity_default_pending	boolean	Whether an eligible account still has to acknowledge the one-time notice about the default game sharing audience
default_share_voice_activity7	boolean	Whether a newly accepted friend relationship starts with voice activity sharing on
table_game_leaderboard_hidden	boolean	Whether the account keeps its table game leagues off the leaderboards and its profile

¹ Duplicate identifiers are removed when the array is written

² An account with an empty stored layout that still holds a legacy guild ordering receives one uncategorised folder holding that ordering. An account with neither receives an empty array

³ The single entry * trusts every domain, and it cannot be combined with a concrete domain

⁴ The field is writable only by a staff account and is reset to its zero value on every settings update from an ordinary account

⁵ Duplicate identifiers are removed and the array is returned in ascending identifier order

⁶ The message is fluxer.user.preferences.v1.SyncedPreferences. The empty string means nothing has been synced yet. The decoded message cannot exceed 524288 bytes, the 512 KiB ceiling

⁷ The field is read-only here and is changed by Modify voice activity sharing

⁸ Eligible new accounts default to everyone; ineligible accounts use off. Older eligible accounts awaiting the default notice acknowledgement keep their earlier setting.

Custom status object

A custom status is the text and emoji stored on the account’s user settings.

Structure

Field	Type	Description
text	?string	The status text (1-128 characters), or null when none is set
expires_at?1	ISO8601 timestamp	The time at which the status expires
emoji_id?1	snowflake	The ID of the custom emoji shown beside the text
emoji_name2	?string	The custom emoji name resolved from emoji_id, the single Unicode emoji supplied directly, or null
emoji_animated	boolean	Whether the selected custom emoji is animated

¹ The field is omitted when the status has no expiry or no custom emoji

² A payload with emoji_id has its emoji_name replaced by the name of that emoji

Example

{
  "text": "shipping",
  "expires_at": "2026-03-04T18:00:00.000Z",
  "emoji_id": "1501314428688998182",
  "emoji_name": "party_parrot",
  "emoji_animated": true
}

Guild folder object

One entry of the saved, user-owned guild sidebar layout. Joining a guild prepends its ID to the uncategorised folder. Leaving or losing a guild removes its ID from every folder and drops any non-uncategorised folder the removal leaves empty, whether or not it has a name.

Structure

Field	Type	Description
id1	?integer	The identifier of the folder
name	?string	The name of the folder, or null when none is set
color2	?integer	The folder colour as packed 24-bit RGB
flags	integer	Guild folder flags
icon3	string	Guild folder icon
guild_ids4	array[snowflake]	The IDs of the guilds in the folder, in sidebar order

¹ The value -1 identifies the uncategorised folder, which holds guilds not placed in a named folder. A stored layout that omits it has it prepended when the layout is written

² A folder written without a colour is stored with 0. The value is null on an uncategorised folder built from a legacy guild ordering or created by a guild join

³ A folder written without an icon is stored with folder

⁴ Writing the layout keeps one occurrence of a guild ID that appears in more than one folder, preferring a named folder over the uncategorised one

Example

{
  "id": -1,
  "name": null,
  "color": null,
  "flags": 0,
  "icon": "folder",
  "guild_ids": ["1501314428688998182", "1501314428688998183"]
}

Guild folder flags

Value	Name	Description
1 << 0	SHOW_ICON_WHEN_COLLAPSED	Show the selected icon instead of guild previews while collapsed

Guild folder icons

Value	Description
folder	Folder icon, applied when no icon is supplied
star	Star icon
heart	Heart icon
bookmark	Bookmark icon
game_controller	Game controller icon
shield	Shield icon
music_note	Music note icon

Sticker animation settings

Value	Name	Description
0	ALWAYS_ANIMATE	Always animate stickers
1	ANIMATE_ON_INTERACTION	Animate stickers during interaction
2	NEVER_ANIMATE	Never animate stickers

Spoiler rendering settings

Value	Name	Description
0	ALWAYS	Always show spoiler content
1	ON_CLICK	Show spoiler content after interaction
2	IF_MODERATOR	Show spoiler content for moderators

Time format settings

Value	Name	Description
0	AUTO	Select the time format from the locale
1	TWELVE_HOUR	Use a 12-hour clock
2	TWENTY_FOUR_HOUR	Use a 24-hour clock

Sensitive media filters

Value	Name	Description
0	SHOW	Show sensitive media
1	BLUR	Blur sensitive media until revealed
2	BLOCK	Hide sensitive media

Guild sensitive media filters

Guild channels accept only these values.

Value	Name	Description
0	SHOW	Show sensitive media
1	BLUR	Blur sensitive media until revealed

Profile privacy levels

A bot account is never subject to profile privacy, and a caller reading its own profile is never restricted. A mutual follow is two accounts that follow each other.

The stored value is read as it is now and is never rewritten in bulk. EVERYONE on an account under 16 or without a date of birth reads as ALL_GUILDS, and a value this table does not list reads as ONLY_ME. Get user profile explains what each level shows to whom.

Value	Name	Description
0	ALL_GUILDS	Friends, mutual follows and members of any shared guild can view the full profile
1	SMALL_GUILDS_ONLY	Legacy value, kept as written and read as ALL_GUILDS
2	FRIENDS_ONLY	Friends and mutual follows can view the full profile
100	EVERYONE	Every signed-in account can view the profile, strangers the public profile
101	ONLY_ME	Only the owner can view the profile content, and nobody can start following the account

Friend source flags

Value	Name	Description
1 << 0	MUTUAL_FRIENDS	Accept requests from users with mutual friends
1 << 1	MUTUAL_GUILDS	Accept requests from users in mutual guilds
1 << 2	NO_RELATION	Accept requests without an existing relation

Incoming call flags

SILENT_EVERYONE applies to calls the other flags already permit. When conflicting policy flags are supplied, FRIENDS_ONLY takes precedence over NOBODY.

Value	Name	Description
1 << 0	FRIENDS_OF_FRIENDS	Permit calls from friends of friends
1 << 1	GUILD_MEMBERS	Permit calls from guild members
1 << 2	EVERYONE	Permit calls from everyone
1 << 3	FRIENDS_ONLY	Permit calls only from friends
1 << 4	NOBODY	Reject all incoming calls
1 << 5	SILENT_EVERYONE	Receive permitted calls silently

Group DM add permission flags

When conflicting policy flags are supplied, FRIENDS_ONLY takes precedence over NOBODY, which takes precedence over EVERYONE.

Value	Name	Description
1 << 0	FRIENDS_OF_FRIENDS	Permit friends of friends to add the user
1 << 1	GUILD_MEMBERS	Permit guild members to add the user
1 << 2	EVERYONE	Permit everyone to add the user
1 << 3	FRIENDS_ONLY	Permit only friends to add the user
1 << 4	NOBODY	Prevent every user from adding the user

User profile object

The account-wide profile customisation inside a full user profile object.

Structure

Field	Type	Description
bio1	?string	The account-wide biography, or null when none is set
pronouns1	?string	The account-wide pronouns, or null when none are set
banner2	?string	The image hash of the profile banner, or null when none is set
banner_color	?integer	The packed 24-bit RGB colour derived from the stored banner, or null
accent_color	?integer	The profile accent colour as packed 24-bit RGB, or null when none is set
theme_colors?	?array[integer]	The profile card gradient, top then bottom colour, or null when unset, hidden, or Plus is not active

¹ The value is forced to null when profile privacy restricts the viewer, which is reported by profile_limited

² The banner hash is not returned while the account lacks the animated banner entitlement, which every profile banner requires. The hash is not returned regardless of profile privacy

Guild member profile object

A guild member profile is the per-guild profile customisation of the target account, in the guild named by the guild_id query parameter.

Structure

Field	Type	Description
bio1	?string	The guild-specific biography, or null when none is set
pronouns1	?string	The guild-specific pronouns, or null when none are set
banner2	?string	The image hash of the guild-specific banner, or null when none is set
accent_color	?integer	The guild profile accent colour as packed 24-bit RGB, or null when none is set

¹ The value is forced to null when profile privacy restricts the viewer

² Micup sets the value to null when the account no longer has premium and the membership has a guild avatar, banner, biography, or accent colour. It stays null until the account joins the guild again. An animated banner hash has the a_ prefix

Mutual guild object

One guild that both the caller and the target account belong to.

Structure

Field	Type	Description
id	snowflake	The ID of the guild
nick	?string	The nickname the target account uses in the guild, or null when none is set

Full user profile object

The profile read returned by Get user profile for one target account.

Structure

Field	Type	Description
user	partial user object	The public representation of the target account
user_profile	user profile object	The account-wide profile customisation
guild_member?1	guild member object	The membership the target account holds in the named guild
guild_member_profile?1	guild member profile object	The per-guild profile customisation of the target account
premium_type?2	integer	The premium type visible to the caller
premium_since?2	ISO8601 timestamp	The premium activation time visible to the caller
premium_lifetime_sequence?2	integer	The lifetime premium sequence visible to the caller
mutual_friends?3	array[partial user object]	The mutual friends in descending account identifier order
mutual_guilds?3	array[mutual guild object]	The guilds the caller and the target are both members of
connected_accounts4	array[connection object]	The verified connections the caller is permitted to see
timezone_offset5	?integer	The offset of the target profile timezone in minutes from UTC, or null
profile_limited?6	boolean	Whether profile privacy removed restricted fields
follower_count?7	integer	How many accounts follow the target
following_count?7	integer	How many accounts the target follows
is_following?8	boolean	Whether the caller follows the target
badges?9	array[badge object]	The catalog badges the target account holds, in ascending badge ID order
profile_effect_data	?cosmetic asset data object	The profile effect the target account wears, or null when none
table_game_leagues?10	array[table game profile league object]	The ranked table leagues the target holds, in game kind order

¹ The pair requires the guild_id query parameter and requires both the caller and the target to be members of that guild

² All three are omitted while the profile is restricted or the target hides the premium badge. premium_since is also omitted while the target hides the activation time. premium_lifetime_sequence is also omitted while the target hides the sequence

³ Each array is omitted unless its query parameter, with_mutual_friends or with_mutual_guilds, is true. Both are always omitted when the target is the caller and on a public profile

⁴ The array is empty when the profile is restricted. It otherwise holds only verified connections whose profile field privacy flags admit the caller, which on a public profile means only those visible to everyone

⁵ The value is null unless the profile is unrestricted, the target has stored a timezone, and its profile field privacy flags admit the caller

⁶ The field is present only on a restricted read

⁷ Both are omitted while the profile is restricted

⁸ Omitted while the profile is restricted and when the target is the caller

⁹ The array is omitted on a restricted read and empty when the target holds no badge

¹⁰ The array is omitted on a restricted read, while ranked tables are off, and when it would be empty. Another caller sees it only while the target shows on leaderboards

A lifetime target that masks its badge reports premium_type of 1, not 2.

Get user

GET/v1/users/{user_id}Bot

Returns a partial user object for any account. Requires no permission and no relationship with the target.

Path parameters

Field	Type	Description
user_id	snowflake	The ID of the target account

A deleted target still resolves

A target whose deletion has completed returns 200 with the substituted deleted account representation, so historical references stay renderable. Only an identifier that was never allocated returns 404 UNKNOWN_USER.

Response

Status	Body	Condition
200	partial user object	User was returned
404	error response	Identifier was never allocated and the request returns UNKNOWN_USER

Rate limit

100 requests per 10 seconds for each authenticated user and target user ID, on the user:read::user_id bucket.

Get user profile

GET/v1/users/{target_id}/profileBot

Returns a full user profile object for one target account.

Limitations

• Reading the caller’s own profile bypasses both the access check and profile privacy.

• A block in either direction limits the profile of a caller with any relationship below, and refuses a caller with none.

• Reading a bot target is always permitted.

• Otherwise the target’s profile privacy level and the caller’s relationship decide the read, as listed below.

• EVERYONE: friends, mutual follows and members of a shared guild read the full profile. Any other caller that qualifies as a stranger, described below, reads the public profile. A caller that does not qualify reads the limited profile with a pending friend request or a shared group DM, and gets 403 without one.

• ALL_GUILDS: friends, mutual follows and members of a shared guild read the full profile. A pending friend request or a shared group DM alone gives the limited profile, and any other caller gets 403.

• FRIENDS_ONLY: friends and mutual follows read the full profile. A shared guild, a pending friend request or a shared group DM gives the limited profile, and any other caller gets 403.

• ONLY_ME: any of those relationships gives the limited profile, and any other caller gets 403.

A stranger is a user session of a non-bot account that is not flagged as a spammer or for suspicious activity and has a verified email address and a claimed account at least 24 hours old. The target must not be disabled, deleted or flagged as a spammer. Each caller can open the public profiles of at most 1,000 different strangers a day, counted by this route, the follow lists and List user posts. Opening the same target again that day counts nothing, and past the cap only a new target is refused with 403. A bot, OAuth2 bearer or Admin credential is never a stranger.

A public profile is a full profile without the mutual friends and mutual guilds, whose fields follow the profile field privacy flags as for a caller with no relationship.

Path parameters

Field	Type	Description
target_id	snowflake	The ID of the target account

Query parameters

Field	Type	Description
guild_id?1	snowflake	The guild whose member and guild profile objects are included
with_mutual_friends?2	boolean	Whether to include mutual friends (default false)
with_mutual_guilds?2	boolean	Whether to include mutual guilds (default false)

¹ A guild that either the caller or the target is not a member of omits guild_member and guild_member_profile. The read still returns 200

² The value is trimmed and read as true only for the exact strings true, True, and 1. Every other value, including absence, is false

Profile privacy is a field filter

A read that passes the access check can still be restricted. A restricted read nulls bio and pronouns in both profile objects, empties connected_accounts, nulls timezone_offset, and sets profile_limited to true. It also removes the premium fields and badges from the body.

Response

Status	Body	Condition
200	full user profile object	Profile was returned
403	error response	The table above refuses the caller
404	error response	Target user does not exist

Side effects

When the target’s premium access and its grace period have both ended, reading the profile clears the target’s stored premium subscription fields. That change emits no Gateway Dispatch and does not prevent the profile from being returned.

Rate limit

100 requests per 10 seconds for each authenticated user and target user ID, on the user:profile::target_id bucket. The route also draws on 120 requests per minute for each authenticated user, whatever the target, on the user:profile:account bucket.

Check user tag

GET/v1/users/check-tag

Reports whether a username and discriminator pair is unavailable.

Query parameters

Field	Type	Description
username1	string	The username after trimming (1-32 ASCII letters, digits, or underscores)
discriminator2	string	The discriminator (1-4 decimal digits)

¹ The value cannot be everyone or here and cannot contain fluxer or system message, all compared case-insensitively

² The value is parsed as a decimal integer before the lookup, so 7, 07, and 0007 describe the same tag

The caller’s current tag returns false. The username comparison is case-insensitive and the discriminator is compared as an integer.

When the caller is not a bot on an instance with the none tag style, the discriminator is ignored. There taken reports whether another account that is not a bot holds the username in any letter case. An account waiting to be deleted still holds its username.

During Micup migration, the availability response preserves taken and can also include reason and available_at. A name can be unavailable because it is taken, reserved, blocked, in a locked or sale tier, or still within its 14-day release embargo. available_at is the embargo/cooldown opening time when provided. Availability never reveals the owner and does not reserve the name; another selection may win before submission. Inputs accept an optional leading @.

A reserved username fails validation with USERNAME_RESERVED_VALUE or USERNAME_CANNOT_CONTAIN_RESERVED_TERMS, and no taken value comes back for it.

Response body

Field	Type	Description
taken	boolean	Whether the normalised tag is unavailable
reason?	string	Why the name is unavailable, as a USERNAME_ code suffix such as TAKEN or RELEASE_EMBARGO
available_at?	?ISO8601 timestamp	When an embargoed or cooling-down name opens again, or null

true also comes from transient conditions

A tag claimed by a registration still in progress reads as taken for up to 30 seconds. A lookup that waits more than 10 seconds on a busy username also reads as taken.

Response

Status	Body	Condition
200	response body	Tag availability was returned

Rate limit

60 requests per 10 seconds for each authenticated user, on the user:check_tag bucket.