Get List Item Note

Get the note for a list item. Only available if the list item's channel is public.

Responses

🟢200`{}` if the list item has no note

application/json

Body

string <uuid>

read-onlyoptional

The ID of the list item

Example:

00000000-0000-0000-0000-000000000000

note

object (Content)

read-onlyoptional

The note content

object

enum<string>

required

Allowed value:

value

Example:

value

document

object

required

noteCreatedAt

string <date-time>

read-onlyoptional

When the note was created

noteCreatedBy

string

optional

The user ID who created the note

noteUpdatedAt

string <date-time>

read-onlyoptional

When the note was last updated

noteUpdatedBy

string

optional

The user ID who last updated the note

Example

{
  "id": "00000000-0000-0000-0000-000000000000",
  "note": {
    "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"
        }
      ]
    }
  },
  "noteCreatedAt": "2019-08-24T14:15:22Z",
  "noteCreatedBy": "string",
  "noteUpdatedAt": "2019-08-24T14:15:22Z",
  "noteUpdatedBy": "string"
}

Request

Request samples

Responses