Guilded Client
  1. Schemas
Guilded Client
  • Intro
  • Community Libraries
  • Permissions Values
  • Reference
  • Webhooks
  • Chat
    • Get Embed for URL
    • Get Metadata
    • Get Channel Messages
    • Get Pinned Messages
  • List Items
    • Get List Items
    • Get List Item Note
  • Users
    • Modify User
    • Get Current User Verification
    • Send Verification Email
    • Verify Email Address
    • Get User Owned Steam Apps
    • Get User
    • Get User Profile
    • Get User Profile Posts
    • Get User Profile Post
    • Check Email Address
  • Teams
    • Get Team Presences
    • Get Team Info
    • Get Shallow Search Results
    • Submit Deep Search Query
    • Check Subdomain
    • Look up Teams
    • Check Team Name
  • 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
  • Schemas
    • Schemas
      • Content
      • Webhook
      • Message
      • Embed
      • OpenGraphEmbed
      • Error
      • ListItem
      • Team
      • Role
      • Permissions
      • SocialLink
      • CustomReaction
      • Member
      • User
      • UserProfile
      • UserAlias
      • UserTransientStatus
      • UserPresenceStatus
      • UserProfilePost
      • GameId
      • SocialLinkType
      • Group
      • Tournament
      • TeamChannel
      • TeamChannelCategory
      • DynamicMediaTypeId
      • GuildedClientId
  1. Schemas

UserProfile(UserProfile)

A user's profile

{
    "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",
    "createdAt": "2019-08-24T14:15:22Z",
    "steamId": null,
    "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"
    },
    "media": [
        null
    ],
    "socialLinks": [
        {
            "type": "twitch",
            "handle": "string",
            "serviceId": "string",
            "additionalInfo": {
                "channelName": "string",
                "socialLinkId": null,
                "id": null
            }
        }
    ],
    "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"
    },
    "deleted": true,
    "teams": [
        {
            "id": "string",
            "name": "string",
            "subdomain": "string",
            "bio": null,
            "status": null,
            "timezone": "string",
            "description": "string",
            "type": "string",
            "visibility": "string",
            "createdAt": "string",
            "ownerId": "string",
            "profilePicture": "string",
            "teamDashImage": "string",
            "homeBannerImageSm": "string",
            "homeBannerImageMd": "string",
            "homeBannerImageLg": "string",
            "additionalInfo": {
                "gameId": "string",
                "source": "NuxTeamCreationFlow",
                "platform": "desktop"
            },
            "additionalGameInfo": {
                "{gameId}": {
                    "region": "North America",
                    "platformps4,xbox,pc": "PC",
                    "101600-sc2region": "North America"
                }
            },
            "socialInfo": {
                "twitch": "string",
                "twitter": "string",
                "youtube": "string",
                "facebook": "string"
            },
            "isRecruiting": true,
            "isVerified": true,
            "isPro": true,
            "isPublic": true,
            "notificationPreference": null,
            "isDiscoverable": true,
            "baseGroup": {
                "id": "x3ZkPHOC",
                "type": "team",
                "name": "Inner Workings",
                "description": null,
                "avatar": null,
                "banner": null,
                "priority": null,
                "teamId": "WjxFFvzG",
                "gameId": null,
                "visibilityTeamRoleId": 24821968,
                "membershipTeamRoleId": 24821968,
                "isBase": true,
                "isPublic": true,
                "additionalGameInfo": {},
                "createdBy": null,
                "createdAt": "2021-08-02T16:59:54.824Z",
                "updatedBy": "EdVMVKR4",
                "customReactionId": null,
                "updatedAt": "2021-08-02T17:12:06.866Z",
                "deletedAt": null,
                "archivedAt": null,
                "archivedBy": null
            },
            "rolesById": {
                "{roleId}": {
                    "id": 0,
                    "name": "string",
                    "color": "string",
                    "color2": "string",
                    "permissions": {
                        "general": 4,
                        "recruitment": 8,
                        "announcements": 16,
                        "chat": 32,
                        "calendar": 64,
                        "forums": 128,
                        "docs": 256,
                        "media": 512,
                        "voice": 1024,
                        "matchmaking": 2048,
                        "customization": 4096,
                        "forms": 8192,
                        "lists": 16384,
                        "brackets": 32768,
                        "scheduling": 65536,
                        "bots": 1,
                        "xp": 1,
                        "streams": 1
                    },
                    "priority": 0,
                    "teamId": "string",
                    "createdAt": "2019-08-24T14:15:22Z",
                    "updatedAt": "2019-08-24T14:15:22Z",
                    "isBase": true,
                    "discordRoleId": "string",
                    "discordSyncedAt": "2019-08-24T14:15:22Z",
                    "isMentionable": true,
                    "isSelfAssignable": true,
                    "isDisplayedSeparately": true,
                    "botScope": {
                        "userId": "string"
                    }
                },
                "baseRole": {
                    "id": 0,
                    "name": "string",
                    "color": "string",
                    "color2": "string",
                    "permissions": {
                        "general": 4,
                        "recruitment": 8,
                        "announcements": 16,
                        "chat": 32,
                        "calendar": 64,
                        "forums": 128,
                        "docs": 256,
                        "media": 512,
                        "voice": 1024,
                        "matchmaking": 2048,
                        "customization": 4096,
                        "forms": 8192,
                        "lists": 16384,
                        "brackets": 32768,
                        "scheduling": 65536,
                        "bots": 1,
                        "xp": 1,
                        "streams": 1
                    },
                    "priority": 0,
                    "teamId": "string",
                    "createdAt": "2019-08-24T14:15:22Z",
                    "updatedAt": "2019-08-24T14:15:22Z",
                    "isBase": true,
                    "discordRoleId": "string",
                    "discordSyncedAt": "2019-08-24T14:15:22Z",
                    "isMentionable": true,
                    "isSelfAssignable": true,
                    "isDisplayedSeparately": true,
                    "botScope": {
                        "userId": "string"
                    }
                }
            },
            "followerCount": 0,
            "memberCount": "string",
            "members": [
                {
                    "id": "string",
                    "name": "string",
                    "nickname": "string",
                    "type": "user",
                    "membershipRole": "admin",
                    "profileBannerBlur": "http://example.com",
                    "profilePicture": "http://example.com",
                    "roleIds": [
                        0
                    ],
                    "userPresenceStatus": 1,
                    "teamXp": -9223372036854776000,
                    "lastOnline": "2019-08-24T14:15:22Z",
                    "joinDate": "2019-08-24T14:15:22Z",
                    "stonks": 0,
                    "aboutInfo": {
                        "tagLine": "string"
                    },
                    "socialLinks": [
                        {
                            "type": "twitch",
                            "handle": "string",
                            "serviceId": "string",
                            "additionalInfo": {
                                "channelName": "string",
                                "socialLinkId": null,
                                "id": null
                            }
                        }
                    ],
                    "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": [
                                                        {}
                                                    ]
                                                }
                                            ],
                                            "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": [
                                                            {}
                                                        ]
                                                    }
                                                ]
                                            }
                                        ],
                                        "": "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
                        }
                    }
                }
            ],
            "serverSubscriptionPlans": [
                {}
            ],
            "teamPaymentInfo": null,
            "games": [
                {
                    "id": 10100
                }
            ],
            "bannerImages": {},
            "lfmStatusByGameId": {},
            "drawbridgeGateEnabled": true,
            "flair": [
                {
                    "id": 1,
                    "amount": 0
                }
            ],
            "socialLinks": [
                {}
            ]
        }
    ]
}
Built with