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

Get Team Info

GET
/teams/{teamId}/info
teams
Get basic info about a team (server). Only available if the team is not private.

Request

Path Params
teamId
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//info'

Responses

🟢200OK
application/json
Body
team
object (Team) 
optional
A team (server)
id
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
Example
{
  "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": [
      {}
    ]
  }
}
🟠404The team does not exist or it is private.
Modified at 2024-06-10 14:16:22
Previous
Get Team Presences
Next
Get Shallow Search Results
Built with