Guilded Client
  1. List Items
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. List Items

Get List Items

GET
/channels/{channelId}/listitems
listItems
Get the list items in the channel. Only available if the channel is public.

Request

Path Params
channelId
string 
required

Request 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/channels//listitems'

Responses

🟢200OK
application/json
Body
array of:
id
string <uuid>
read-onlyrequired
The ID of the list item
Example:
00000000-0000-0000-0000-000000000000
parentId
string <uuid> | null 
read-onlyoptional
The parent list item ID of the list item
Example:
00000000-0000-0000-0000-000000000000
channelId
string <uuid>
read-onlyrequired
The channel ID of the list item
Example:
00000000-0000-0000-0000-000000000000
teamId
string 
read-onlyrequired
The team ID of the list item
createdBy
string 
required
The author ID that created the list item
webhookId
string <uuid> | null 
read-onlyoptional
The webhook ID that created the list item
Example:
00000000-0000-0000-0000-000000000000
createdAt
string <date-time>
read-onlyrequired
When the list item was created
updatedBy
string  | null 
optional
The user ID that last updated the list item
updatedAt
string  | null 
optional
When the list item was last updated
message
object (Content) 
read-onlyrequired
The main content of the list item
object
enum<string> 
required
Allowed value:
value
Example:
value
document
object 
required
note
object (Content) 
read-onlyoptional
The note of the list item, not returned when reading many list items at once
hasNote
boolean 
optional
Whether the list item has a note
Default:
false
noteCreatedBy
string  | null 
optional
The user ID that created the note
noteCreatedAt
string <date-time> | null 
read-onlyoptional
When the note was created
noteUpdatedBy
string  | null 
optional
The user ID who last updated the note
noteUpdatedAt
string <date-time> | null 
read-onlyoptional
When the note was last updated
completedBy
string  | null 
optional
The user ID who last marked the list item as completed
completedAt
string <date-time> | null 
read-onlyoptional
When the list item was last marked as completed
deletedBy
string  | null 
read-onlyoptional
The user ID who deleted the list item
deletedAt
string <date-time> | null 
read-onlyoptional
When the list item was deleted
priority
integer 
deprecated
Unknown, not related to visual hierarchy
Example:
0
assignedTo
array [object {3}] 
optional
A list of roles or users that are "assigned to" the list item, as represented by their mention in message
listItemId
string <uuid>
required
The ID of the list item
Example:
00000000-0000-0000-0000-000000000000
mentionType
enum<string> 
read-onlyrequired
The type of object that was mentioned
Allowed values:
roleperson
mentionId
string  | integer 
read-onlyrequired
The ID of the object that was mentioned
Example
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "parentId": "00000000-0000-0000-0000-000000000000",
    "channelId": "00000000-0000-0000-0000-000000000000",
    "teamId": "string",
    "createdBy": "string",
    "webhookId": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "updatedAt": "string",
    "message": {
      "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"
          }
        ]
      }
    },
    "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"
          }
        ]
      }
    },
    "hasNote": false,
    "noteCreatedBy": "string",
    "noteCreatedAt": "2019-08-24T14:15:22Z",
    "noteUpdatedBy": "string",
    "noteUpdatedAt": "2019-08-24T14:15:22Z",
    "completedBy": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "deletedAt": "2019-08-24T14:15:22Z",
    "priority": 0,
    "assignedTo": [
      {
        "listItemId": "00000000-0000-0000-0000-000000000000",
        "mentionType": "role",
        "mentionId": "string"
      }
    ]
  }
]
Modified at 2024-06-10 14:16:22
Previous
Get Pinned Messages
Next
Get List Item Note
Built with