Get Pinned Messages

Get the pinned messages from a channel. Only available if the channel is public.

Responses

🟢200OK

application/json

Body

messages

array[object (Message) {12}]

optional

string <uuid>

read-onlyrequired

The ID of the message

Example:

00000000-0000-0000-0000-000000000000

channelId

string <uuid>

read-onlyrequired

The ID of the channel

Example:

00000000-0000-0000-0000-000000000000

content

object (Content)

read-onlyrequired

The content of the message

type

enum<string>

read-onlyoptional

The type of message

Allowed values:

defaultsystem

Default:

default

createdBy

string

read-onlyrequired

The user ID that created the message

>= 8 characters

Example:

Ann6LewA

createdAt

string <date-time>

read-onlyrequired

When the message was created

webhookId

string <uuid>

optional

The webhook ID that created the message

Example:

00000000-0000-0000-0000-000000000000

isOptimistic

boolean

deprecated

Unknown

isPrivate

boolean

optional

Whether the message is only visible to the users mentioned within its content and to moderators with "Moderator view" enabled

Default:

false

isSilent

boolean

optional

Whether the mentions in this message were silenced (not delivered to recipients)

Default:

false

repliesToIds

array[string <uuid>]

read-onlyoptional

A list of message IDs that the message is in reply to

>= 0 items<= 5 items

guildedClientId

string | null

read-onlyoptional

The ID of the applicable client. Usually a UUID, but will be rest-api if said client is an application who performed an action from Guilded's bot API

Example:

00000000-0000-0000-0000-000000000000

Example

{
  "messages": [
    {
      "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"
    }
  ]
}

🟠403Must have the correct permissions to read content for this channel

🟠404Channel not found

Request

Request samples

Responses