Get Metadata

Get metadata intended for embedding in the Guilded client

Responses

🟢200OK

application/json

Body

title

string

required

The title of the page

description

string

required

The description of the page

canonicalUrl

string

required

Likely the URL passed to route

originalUrl

string

required

The original URL of the resource, sometimes the same as canonicalUrl

breadcrumb

array [object {2}]

required

More paths this resource is available at

>= 0 items

name

string

required

The name of the page

path

string

required

The path

image

object

optional

Images to show with the metadata

thumbnail

object

optional

An embed thumbnail

team

object (Team)

optional

The team that was requested if route points to a team

string

required

name

string

required

subdomain

string

optional

bio

null

optional

status

null

optional

timezone

string

optional

description

string

optional

type

string

optional

visibility

string

optional

createdAt

string

optional

ownerId

string

optional

profilePicture

string

optional

teamDashImage

string

optional

homeBannerImageSm

string

optional

homeBannerImageMd

string

optional

homeBannerImageLg

string

optional

additionalInfo

object

optional

additionalGameInfo

object

optional

socialInfo

object

optional

External social links for the team

isRecruiting

boolean

optional

isVerified

boolean

optional

isPro

boolean

optional

isPublic

boolean

optional

notificationPreference

null

optional

isDiscoverable

boolean

optional

baseGroup

object (Group)

optional

A group in a team (server), which is able to hold its own channels and avatar/banner information (Support article)

Example:

{"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

object

required

The roles in the team

followerCount

integer

optional

The number of users following the team

memberCount

string | integer

optional

The number of members the team has

members

array[object (Member) {16}]

optional

Not actually all members of the team, but instead an array containing only the current user if they are a member of the server (never)

serverSubscriptionPlans

array [object]

optional

teamPaymentInfo

null

optional

games

array [object {1}]

optional

bannerImages

object

optional

lfmStatusByGameId

object

optional

drawbridgeGateEnabled

boolean

optional

flair

array [object {2}]

optional

The flairs that the team has

socialLinks

array [object]

optional

channel

object (TeamChannel)

optional

The channel that was requested if route points to a channel or a message in a channel

string <uuid>

required

The ID of the channel

Example:

00000000-0000-0000-0000-000000000000

name

string

required

The name of the channel, can contain spaces & capitalization

>= 1 characters<= 100 characters

type

enum<string>

required

The type of channel (you probably want contentType instead)

Allowed value:

Team

contentType

enum<string>

required

The content type of channel

Allowed values:

announcementcalendarchatdocforummedialistschedulingstreamingvoice

priority

integer

optional

description

string | null

optional

The description (topic) of the channel

settings

object

optional

Settings for the channel

roles

array | null

deprecated

rolesById

object

required

Permission settings for roles, categorized by their IDs as strings ({roleId})

tournamentRolesById

object

optional

teamId

string

required

The ID of the team that the channel is in

channelCategoryId

integer | null

optional

The ID of the category that the channel is in

addedAt

string <date-time> | null

optional

Unknown - possible duplicate of createdAt

channelId

string <uuid>

deprecated

The ID of the channel (duplicate of id)

Example:

00000000-0000-0000-0000-000000000000

isRoleSynced

boolean | null

optional

Whether role overrides in the channel are synced with its category (assume true if null)

isPublic

boolean

optional

Whether the channel is public

groupId

string

optional

The ID of the group that the channel is in

createdAt

string <date-time>

required

When the channel was created

createdBy

string

required

The user ID who created the channel

updatedAt

string <date-time> | null

optional

When the channel was last updated

archivedAt

string | null

optional

When the channel was archived

parentChannelId

string <uuid> | null

optional

If the channel is a thread, the ID of the parent channel or thread that it is in

Example:

00000000-0000-0000-0000-000000000000

autoArchiveAt

string <date-time> | null

optional

If the channel is a thread, the datetime that it will automatically be archived at

deletedAt

string <date-time> | null

optional

When the channel was deleted

archivedBy

string | null

optional

The user ID who archived the channel

createdByWebhookId

string <uuid> | null

optional

The webhook ID that created the channel

Example:

00000000-0000-0000-0000-000000000000

archivedByWebhookId

string <uuid> | null

optional

The webhook ID that archived the channel

Example:

00000000-0000-0000-0000-000000000000

userPermissions

array [object {6}] | null

optional

User-based permission overrides in the channel

tournamentRoles

array | null

optional

originatingChannelContentType

enum<string>

optional

If the channel is a thread, the content type of the top-level channel it is ultimately in

Allowed values:

chatliststreamingvoice

originatingChannelId

string <uuid>

optional

If the channel is a thread, the ID of the top-level channel it is ultimately in

Example:

00000000-0000-0000-0000-000000000000

participants

array [object {1}]

optional

The members of the thread

userIds

array[string]

optional

The user IDs of the thread members, sometimes provided alongside participants

threadMessageId

string <uuid> | null

optional

The ID of the initial thread message, if any

Example:

00000000-0000-0000-0000-000000000000

lastMessage

object (Message)

optional

The most recent message in the thread

messageCount

integer

optional

The total number of messages in the thread, excluding the initial message

message

object (Message)

optional

The message that was requested if route points to a message

user

object (User)

optional

The user that was requested if route points to a user

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

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

moderationStatus

enum<string> | enum<null>

read-onlyoptional

The moderation status of the user

Allowed values:

banneddeleted

aboutInfo

object

optional

Profile info for 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

Example

{
  "title": "string",
  "description": "string",
  "canonicalUrl": "string",
  "originalUrl": "string",
  "breadcrumb": [
    {
      "name": "string",
      "path": "string"
    }
  ],
  "image": {
    "thumbnail": {
      "src": "string"
    }
  },
  "team": {
    "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": [
                          {
                            "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": {}
                            }
                          ]
                        }
                      ]
                    }
                  ],
                  "": "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": [
      {}
    ]
  },
  "channel": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "type": "Team",
    "contentType": "announcement",
    "priority": 0,
    "description": "string",
    "settings": {
      "isBlog": true,
      "disableComments": true,
      "slowMode": 5
    },
    "roles": [
      null
    ],
    "rolesById": {
      "{roleId}": {
        "teamId": "string",
        "channelId": "00000000-0000-0000-0000-000000000000",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "teamRoleId": 0,
        "allowPermissions": {
          "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
        },
        "denyPermissions": {
          "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
        }
      }
    },
    "tournamentRolesById": {},
    "teamId": "string",
    "channelCategoryId": 0,
    "addedAt": "2019-08-24T14:15:22Z",
    "channelId": "00000000-0000-0000-0000-000000000000",
    "isRoleSynced": true,
    "isPublic": true,
    "groupId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "archivedAt": "string",
    "parentChannelId": "00000000-0000-0000-0000-000000000000",
    "autoArchiveAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "archivedBy": "string",
    "createdByWebhookId": "00000000-0000-0000-0000-000000000000",
    "archivedByWebhookId": "00000000-0000-0000-0000-000000000000",
    "userPermissions": [
      {
        "userId": "string",
        "channelId": "00000000-0000-0000-0000-000000000000",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "allowPermissions": {
          "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
        },
        "denyPermissions": {
          "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
        }
      }
    ],
    "tournamentRoles": [
      null
    ],
    "originatingChannelContentType": "chat",
    "originatingChannelId": "00000000-0000-0000-0000-000000000000",
    "participants": [
      {
        "id": "string"
      }
    ],
    "userIds": [
      "string"
    ],
    "threadMessageId": "00000000-0000-0000-0000-000000000000",
    "lastMessage": {
      "id": "00000000-0000-0000-0000-000000000000",
      "channelId": "00000000-0000-0000-0000-000000000000",
      "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"
            }
          ]
        }
      },
      "type": "default",
      "createdBy": "Ann6LewA",
      "createdAt": "2019-08-24T14:15:22Z",
      "webhookId": "00000000-0000-0000-0000-000000000000",
      "isOptimistic": true,
      "isPrivate": false,
      "isSilent": false,
      "repliesToIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "guildedClientId": "00000000-0000-0000-0000-000000000000"
    },
    "messageCount": 0
  },
  "message": {
    "id": "00000000-0000-0000-0000-000000000000",
    "channelId": "00000000-0000-0000-0000-000000000000",
    "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"
          }
        ]
      }
    },
    "type": "default",
    "createdBy": "Ann6LewA",
    "createdAt": "2019-08-24T14:15:22Z",
    "webhookId": "00000000-0000-0000-0000-000000000000",
    "isOptimistic": true,
    "isPrivate": false,
    "isSilent": false,
    "repliesToIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "guildedClientId": "00000000-0000-0000-0000-000000000000"
  },
  "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"
    }
  }
}

Request

Request samples

Responses