Get User Profile

Get a user's profile

Responses

🟢200OK

application/json

Body

A global user, not part of a team (server)

string

required

The ID of the user

name

string

required

The name of the user

subdomain

string

optional

The subdomain (vanity URL code) of the user

aliases

array[object (UserAlias) {11}]

optional

alias

string | null

required

The display alias itself

discriminator

string | null

optional

The discriminator of the alias

name

string

required

The name of the profile in the game the alias is for

createdAt

string <date-time>

required

When the alias was created

userId

string

required

The user ID that the alias is owned by

gameId

integer | string

required

A hardcoded ID for a game

>= 10100<= 477074

socialLinkSource

optional

The type of social link that the alias is from, if any

socialLinkHandle

string | null

optional

The social link handle, if the alias is from a social link

additionalInfo

object

optional

Extra info about the alias

editedAt

string <date-time>

optional

When the alias was last updated

playerInfo

null

optional

Extra info about the profile

string | null

deprecated

The email of the user, never populated for users other than yourself

serviceEmail

string | null

deprecated

Similar to email, you can expect this to always be null

profilePicture

string <uri> | null

read-onlyoptional

The URL to the CDN asset of the user's profile picture

profilePictureSm

string <uri> | null

deprecated

The URL to the CDN asset of the user's profile picture

profilePictureLg

string <uri> | null

deprecated

The URL to the CDN asset of the user's profile picture

profilePictureBlur

string | null

deprecated

The URL to the CDN asset of the user's profile picture

profileBannerBlur

string | null

deprecated

The URL to the CDN asset of the user's banner

profileBannerLg

string | null

read-onlyoptional

The URL to the CDN asset of the user's banner

profileBannerSm

string | null

read-onlyoptional

The URL to the CDN asset of the user's banner

joinDate

string

required

When the user account was created

steamId

null

deprecated

The steam ID of the user (never populated; superseded by socialLinks)

robloxId

string | null

optional

The roblox ID associated with the account

userStatus

object

optional

The custom status of the user

content

required

The inner content of the status

customReactionId

integer | null

required

The emoji ID displayed to the left of content

customReaction

object (CustomReaction)

optional

The emoji displayed to the left of content

Examples:

{"id":761262,"name":"frog-donut","png":"https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120","webp":"https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120","apng":null}{"id":90002582,"name":"hyperclap_gil","png":"/asset/Emojis/Custom/hyperclap_gil.png","webp":null,"apng":"/asset/Emojis/Custom/hyperclap_gil.gif"}{"id":90000027,"name":"face_with_rolling_eyes","png":null,"webp":null,"apng":null}

moderationStatus

enum<string> | enum<null>

read-onlyoptional

The moderation status of the user

Allowed values:

banneddeleted

aboutInfo

object

optional

Profile info for the user

bio

string

optional

The bio of the user

tagLine

string

optional

The tagline of the user

lastOnline

string <date-time>

read-onlyoptional

When the user was last online

userPresenceStatus

enum<integer>

optional

Enum representing a user's presence

Value	Meaning	Color
1	Online	Green
2	Idle	Orange
3	Do not disturb	Red
4	Offline / invisible	Gray

Allowed values:

1234

userTransientStatus

optional

The transient status of the user, if any

One of

UserTransientStatus

null

A game activity for a user

Example:

{"gameId":10100,"id":3334,"type":"gamepresence","startedAt":"2022-09-11T15:21:42.111Z","guildedClientId":"00000000-0000-0000-0000-000000000000"}

gameId

integer | string

GameId

required

A hardcoded ID for a game

>= 10100<= 477074

integer | null

read-onlyoptional

The ID of the transient status

type

enum<string>

read-onlyrequired

The type of transient status

Allowed value:

gamepresence

startedAt

string <date-time>

read-onlyrequired

When the transient status began

Example:

2022-09-11T15:21:42.111Z

guildedClientId

string <uuid>

read-onlyoptional

The ID of the Guilded client that the transient status is from

Example:

00000000-0000-0000-0000-000000000000

Example

{
    "id": "string",
    "name": "string",
    "subdomain": "string",
    "aliases": [
        {
            "alias": "string",
            "discriminator": "string",
            "name": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "userId": "string",
            "gameId": 10100,
            "socialLinkSource": "twitch",
            "socialLinkHandle": "string",
            "additionalInfo": {
                "pubg-servers": "Europe (EU)",
                "101700-esocp": "string",
                "101700-esolevel": "string",
                "101700-esoclasses": "Necromancer",
                "101700-esoalliances": "string",
                "rocketleague-rank": "Unranked",
                "rocketleague-modes": [
                    {
                        "value": true,
                        "optionName": "rocketleague-modes-vduel"
                    }
                ],
                "rocketleague-skill-rating": "string",
                "charactername": "string",
                "startcitizen-org-user-activities": [
                    {
                        "value": true,
                        "optionName": "starcitizen-org-user-activities-bountyhunting"
                    }
                ]
            },
            "editedAt": "2019-08-24T14:15:22Z",
            "playerInfo": null
        }
    ],
    "email": "string",
    "serviceEmail": "string",
    "profilePicture": "http://example.com",
    "profilePictureSm": "http://example.com",
    "profilePictureLg": "http://example.com",
    "profilePictureBlur": "string",
    "profileBannerBlur": "string",
    "profileBannerLg": "string",
    "profileBannerSm": "string",
    "joinDate": "string",
    "steamId": null,
    "robloxId": "string",
    "userStatus": {
        "content": {
            "object": "value",
            "document": {
                "object": "document",
                "data": {
                    "profile": {
                        "name": "shay",
                        "profilePicture": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/WebhookThumbnail/3626a9cdc1020a98bd6c1724049c89a8-Full.webp?w=160&h=160"
                    },
                    "hiddenEmbedUrls": {
                        "{url}": false
                    }
                },
                "nodes": [
                    {
                        "object": "block",
                        "type": "markdown-plain-text",
                        "data": {
                            "isEmbedMessage": false,
                            "embeds": [
                                {
                                    "title": "string",
                                    "description": "string",
                                    "url": "string",
                                    "color": 0,
                                    "timestamp": "string",
                                    "footer": {
                                        "text": "string",
                                        "icon_url": "string",
                                        "iconUrl": "string"
                                    },
                                    "thumbnail": {
                                        "url": "string"
                                    },
                                    "image": {
                                        "url": "string"
                                    },
                                    "author": {
                                        "name": "string",
                                        "url": "string",
                                        "icon_url": "string",
                                        "iconUrl": "string"
                                    },
                                    "fields": [
                                        {
                                            "name": "string",
                                            "value": "string",
                                            "inline": true
                                        }
                                    ]
                                }
                            ],
                            "url": "string",
                            "createdBy": "string",
                            "oldName": "string",
                            "newName": "string",
                            "type": "channel-renamed"
                        },
                        "nodes": [
                            {
                                "object": "text",
                                "type": "mention",
                                "data": {
                                    "mention": {
                                        "type": "role",
                                        "matcher": "string",
                                        "name": "string",
                                        "nickname": true,
                                        "color": "string",
                                        "id": "string",
                                        "sortOrder": 0
                                    },
                                    "reaction": {
                                        "id": 0,
                                        "customReactionId": 0,
                                        "customReaction": {
                                            "id": 761262,
                                            "name": "frog-donut",
                                            "png": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
                                            "webp": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
                                            "apng": null
                                        }
                                    },
                                    "channel": {
                                        "id": "string"
                                    },
                                    "href": "string"
                                },
                                "leaves": [
                                    {
                                        "object": "leaf",
                                        "text": "string",
                                        "marks": [
                                            {
                                                "data": {},
                                                "object": "mark",
                                                "type": "bold"
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "": "string"
                    }
                ]
            }
        },
        "customReactionId": 0,
        "customReaction": {
            "id": 761262,
            "name": "frog-donut",
            "png": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
            "webp": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
            "apng": null
        }
    },
    "moderationStatus": "banned",
    "aboutInfo": {
        "bio": "string",
        "tagLine": "string"
    },
    "lastOnline": "2019-08-24T14:15:22Z",
    "userPresenceStatus": 1,
    "userTransientStatus": {
        "gameId": 10100,
        "id": 3334,
        "type": "gamepresence",
        "startedAt": "2022-09-11T15:21:42.111Z",
        "guildedClientId": "00000000-0000-0000-0000-000000000000"
    }
}

Request

Request samples

Responses