Guilded Client
  1. Channels
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 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
    • Get Team Channel
      GET
    • Get Group Archived Channels
      GET
    • Get Thread
      GET
    • Get Channel Threads
      GET
    • Get Channel Thread Count
      GET
    • Get Voice Channel Groups
      GET
  • 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. Channels

Get Group Archived Channels

GET
/teams/{teamId}/groups/{groupId}/channels/archived
channels
Get the list of archived channels for a specific team group

Request

Path Params
teamId
string 
required
groupId
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/teams//groups//channels/archived'

Responses

🟢200Returns `{}` if `groupId` is invalid
application/json
Body
channels
array[object (TeamChannel) {36}] 
optional
The archived channels in the group
id
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
Example
{
  "channels": [
    {
      "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
    }
  ]
}
Modified at 2024-06-10 14:16:22
Previous
Get Team Channel
Next
Get Thread
Built with