Guilded Client
  1. Users
Guilded Client
  • Intro
  • Community Libraries
  • Permissions Values
  • Reference
  • Webhooks
  • Chat
    • Get Embed for URL
      GET
    • Get Metadata
      GET
    • Get Channel Messages
      GET
    • Get Pinned Messages
      GET
  • List Items
    • Get List Items
      GET
    • Get List Item Note
      GET
  • Users
    • Modify User
      GET
    • Get Current User Verification
      GET
    • Send Verification Email
      POST
    • Verify Email Address
      GET
    • Get User Owned Steam Apps
      GET
    • Get User
      GET
    • Get User Profile
      GET
    • Get User Profile Posts
      GET
    • Get User Profile Post
      GET
    • Check Email Address
      GET
  • Teams
    • Get Team Presences
      GET
    • Get Team Info
      GET
    • Get Shallow Search Results
      GET
    • Submit Deep Search Query
      GET
    • Check Subdomain
      GET
    • Look up Teams
      GET
    • Check Team Name
      GET
  • Members
    • Get Team Members
    • Detail Team Members
    • Detail Voice Members
    • Sort Member IDs
    • Detail Team Bots
  • Channels
    • Get Team Channels
    • Get Team Channel
    • Get Group Archived Channels
    • Get Thread
    • Get Channel Threads
    • Get Channel Thread Count
    • Get Voice Channel Groups
  • Webhooks
    • Get Channel Webhooks
    • Execute Webhook
  • Guilded Meta
    • Redirect to App
    • Get App QR
  • Tournaments
    • Get Tournaments
    • Get Tournament
    • Get Tournament Info
    • Get Tournament Any Bracket Confirmed
    • Get Tournament from Invite
    • Get Tournament Hash Invites
    • Get Tournament Bracket Matches
    • Get Upcoming Tournaments
    • Get Completed Tournaments
    • Get Featured Tournaments
  • Websocket
    • Websocket
  1. Users

Get User

GET
/users/{userId}
Get a user

Request

Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://www.guilded.gg/api/users/'

Responses

🟢200For banned and deleted users, this is still returned but with data anonymized and the `moderationStatus` property set appropriately.
application/json
Body

Example
{
    "user": {
        "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"
        }
    }
}
🟠404No such user
Modified at 2024-06-10 14:16:22
Previous
Get User Owned Steam Apps
Next
Get User Profile
Built with