get
/users/{target_id}/profileGet user profile
Retrieves detailed profile information for a user, including bio, custom status, and badges. Optionally includes mutual friends and mutual guilds if requested. May respect privacy settings.
get_user_profile
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| target_id* | path | string | The target id |
| guild_id | query | SnowflakeType | |
| with_mutual_friends | query | string | |
| with_mutual_guilds | query | string |
Responses
200
Success
json
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"description": "The unique identifier (snowflake) for this user"
},
"username": {
"type": "string",
"description": "The username of the user, not unique across the platform"
},
"discriminator": {
"type": "string",
"description": "The four-digit discriminator tag of the user"
},
"global_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The display name of the user, if set"
},
"avatar": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The hash of the user avatar image"
},
"avatar_color": {
"anyOf": [
{
"$ref": "#/components/schemas/Int32Type"
},
{
"type": "null"
}
],
"description": "The dominant avatar color of the user as an integer"
},
"bot": {
"type": "boolean",
"description": "Whether the user is a bot account"
},
"system": {
"type": "boolean",
"description": "Whether the user is an official system user"
},
"flags": {
"$ref": "#/components/schemas/PublicUserFlags"
},
"mention_flags": {
"$ref": "#/components/schemas/MentionReplyPreferences",
"description": "The user's account-wide reply mention preference"
}
},
"required": [
"id",
"username",
"discriminator",
"global_name",
"avatar",
"avatar_color",
"flags"
],
"description": "The user object"
},
"user_profile": {
"type": "object",
"properties": {
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "User biography text"
},
"pronouns": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "User pronouns"
},
"banner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Hash of the profile banner image"
},
"banner_color": {
"anyOf": [
{
"$ref": "#/components/schemas/Int32Type"
},
{
"type": "null"
}
],
"description": "Default banner color if no custom banner"
},
"accent_color": {
"anyOf": [
{
"$ref": "#/components/schemas/Int32Type"
},
{
"type": "null"
}
],
"description": "User-selected accent color"
}
},
"required": [
"bio",
"pronouns",
"banner",
"accent_color"
],
"description": "The user profile data"
},
"guild_member": {
"$ref": "#/components/schemas/GuildMemberResponse"
},
"guild_member_profile": {
"anyOf": [
{
"type": "object",
"properties": {
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Guild-specific biography text"
},
"pronouns": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Guild-specific pronouns"
},
"banner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Hash of the guild-specific banner image"
},
"accent_color": {
"anyOf": [
{
"$ref": "#/components/schemas/Int32Type"
},
{
"type": "null"
}
],
"description": "Guild-specific accent color"
}
},
"required": [
"bio",
"pronouns",
"banner",
"accent_color"
]
},
{
"type": "null"
}
],
"description": "Guild-specific profile data"
},
"premium_type": {
"$ref": "#/components/schemas/UserPremiumTypes",
"description": "The type of premium subscription"
},
"premium_since": {
"type": "string",
"description": "ISO8601 timestamp of when premium was activated"
},
"premium_lifetime_sequence": {
"$ref": "#/components/schemas/Int32Type"
},
"mutual_friends": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserPartialResponse"
},
"description": "Array of mutual friends"
},
"mutual_guilds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"description": "The ID of the mutual guild"
},
"nick": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The nickname of the target user in this guild"
}
},
"required": [
"id",
"nick"
]
},
"description": "Array of mutual guilds"
},
"connected_accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectionResponse"
},
"description": "Array of verified external connections"
},
"timezone_offset": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"format": "int32"
},
{
"type": "null"
}
],
"description": "Current timezone offset in minutes from UTC for the target user's profile timezone, or null when hidden or unset"
},
"profile_limited": {
"type": "boolean",
"description": "True when the target user has restricted their profile and the viewer does not meet the visibility tier; bio, pronouns, badges, and connected accounts have been stripped."
}
},
"required": [
"user",
"user_profile",
"timezone_offset"
]
}400
Bad Request - The request was malformed or contained invalid data
json
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/APIErrorCode"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"type": "array",
"description": "Field-specific validation errors",
"items": {
"$ref": "#/components/schemas/ValidationErrorItem"
}
}
},
"required": [
"code",
"message"
]
}401
Unauthorized - Authentication is required or the token is invalid
json
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/APIErrorCode"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"type": "array",
"description": "Field-specific validation errors",
"items": {
"$ref": "#/components/schemas/ValidationErrorItem"
}
}
},
"required": [
"code",
"message"
]
}403
Forbidden - You do not have permission to perform this action
json
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/APIErrorCode"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"type": "array",
"description": "Field-specific validation errors",
"items": {
"$ref": "#/components/schemas/ValidationErrorItem"
}
}
},
"required": [
"code",
"message"
]
}429
Too Many Requests - You are being rate limited
json
{
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"RATE_LIMITED"
]
},
"message": {
"type": "string"
},
"retry_after": {
"type": "number",
"description": "Seconds to wait before retrying"
},
"global": {
"type": "boolean",
"description": "Whether this is a global rate limit"
}
},
"required": [
"code",
"message",
"retry_after"
]
}500
Internal Server Error - An unexpected error occurred
json
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/APIErrorCode"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"type": "array",
"description": "Field-specific validation errors",
"items": {
"$ref": "#/components/schemas/ValidationErrorItem"
}
}
},
"required": [
"code",
"message"
]
}