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 | SnowflakeType | The ID of the target user |
| guild_id | query | SnowflakeType | Optional guild ID for guild-specific profile |
| with_mutual_friends | query | string | Whether to include mutual friends |
| with_mutual_guilds | query | string | Whether to include mutual guilds |
Responses
200
Success
json
{
"type": "object",
"properties": {
"user": {
"description": "The user object",
"$ref": "#/components/schemas/UserPartialResponse"
},
"user_profile": {
"type": "object",
"properties": {
"bio": {
"description": "User biography text",
"type": [
"string",
"null"
]
},
"pronouns": {
"description": "User pronouns",
"type": [
"string",
"null"
]
},
"banner": {
"description": "Hash of the profile banner image",
"type": [
"string",
"null"
]
},
"banner_color": {
"description": "Default banner color if no custom banner",
"anyOf": [
{
"$ref": "#/components/schemas/Int32Type"
},
{
"type": "null"
}
]
},
"accent_color": {
"anyOf": [
{
"$ref": "#/components/schemas/Int32Type"
},
{
"type": "null"
}
],
"description": "User-selected accent color"
}
},
"required": [
"bio",
"pronouns",
"banner",
"accent_color"
],
"additionalProperties": false,
"description": "The user profile data"
},
"guild_member": {
"description": "The guild member data if guild_id was provided",
"$ref": "#/components/schemas/GuildMemberResponse"
},
"guild_member_profile": {
"description": "Guild-specific profile data",
"anyOf": [
{
"type": "object",
"properties": {
"bio": {
"description": "Guild-specific biography text",
"type": [
"string",
"null"
]
},
"pronouns": {
"description": "Guild-specific pronouns",
"type": [
"string",
"null"
]
},
"banner": {
"description": "Hash of the guild-specific banner image",
"type": [
"string",
"null"
]
},
"accent_color": {
"anyOf": [
{
"$ref": "#/components/schemas/Int32Type"
},
{
"type": "null"
}
],
"description": "Guild-specific accent color"
}
},
"required": [
"bio",
"pronouns",
"banner",
"accent_color"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"premium_type": {
"$ref": "#/components/schemas/UserPremiumTypes",
"description": "The type of premium subscription"
},
"premium_since": {
"description": "ISO8601 timestamp of when premium was activated",
"type": "string"
},
"premium_lifetime_sequence": {
"description": "Sequence number for lifetime premium",
"$ref": "#/components/schemas/Int32Type"
},
"mutual_friends": {
"description": "Array of mutual friends",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserPartialResponse"
}
},
"mutual_guilds": {
"description": "Array of mutual guilds",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "The ID of the mutual guild",
"$ref": "#/components/schemas/SnowflakeStringType"
},
"nick": {
"description": "The nickname of the target user in this guild",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"nick"
],
"additionalProperties": false
}
},
"connected_accounts": {
"description": "Array of verified external connections",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectionResponse"
}
},
"timezone_offset": {
"anyOf": [
{
"$ref": "#/components/schemas/SignedInt32Type"
},
{
"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": {
"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.",
"type": "boolean"
}
},
"required": [
"user",
"user_profile",
"timezone_offset"
],
"additionalProperties": false
}400
Bad Request - The request was malformed or contained invalid data
json
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Machine-readable error code"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"description": "Field-specific validation errors",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Field path that failed validation"
},
"code": {
"description": "Machine-readable validation error code",
"type": "string"
},
"message": {
"type": "string",
"description": "Human-readable validation error message"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"code",
"message"
],
"additionalProperties": {}
}401
Unauthorized - Authentication is required or the token is invalid
json
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Machine-readable error code"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"description": "Field-specific validation errors",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Field path that failed validation"
},
"code": {
"description": "Machine-readable validation error code",
"type": "string"
},
"message": {
"type": "string",
"description": "Human-readable validation error message"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"code",
"message"
],
"additionalProperties": {}
}403
Forbidden - You do not have permission to perform this action
json
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Machine-readable error code"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"description": "Field-specific validation errors",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Field path that failed validation"
},
"code": {
"description": "Machine-readable validation error code",
"type": "string"
},
"message": {
"type": "string",
"description": "Human-readable validation error message"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"code",
"message"
],
"additionalProperties": {}
}429
Too Many Requests - You are being rate limited
json
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Machine-readable error code"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"description": "Field-specific validation errors",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Field path that failed validation"
},
"code": {
"description": "Machine-readable validation error code",
"type": "string"
},
"message": {
"type": "string",
"description": "Human-readable validation error message"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
},
"retry_after": {
"type": "number",
"description": "Seconds to wait before retrying"
},
"global": {
"type": "boolean",
"description": "Whether this is a global rate limit"
}
},
"required": [
"code",
"message"
],
"additionalProperties": {}
}500
Internal Server Error - An unexpected error occurred
json
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Machine-readable error code"
},
"message": {
"type": "string",
"description": "Human-readable error message"
},
"errors": {
"description": "Field-specific validation errors",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Field path that failed validation"
},
"code": {
"description": "Machine-readable validation error code",
"type": "string"
},
"message": {
"type": "string",
"description": "Human-readable validation error message"
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"code",
"message"
],
"additionalProperties": {}
}