Guilded Client
  1. Tournaments
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 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
    • Get Tournament
      GET
    • Get Tournament Info
      GET
    • Get Tournament Any Bracket Confirmed
      GET
    • Get Tournament from Invite
      GET
    • Get Tournament Hash Invites
      GET
    • Get Tournament Bracket Matches
      GET
    • Get Upcoming Tournaments
      GET
    • Get Completed Tournaments
      GET
    • Get Featured Tournaments
      GET
  • Websocket
    • Websocket
  1. Tournaments

Get Tournament Info

GET
/tournaments/{tournamentId}/info
tournaments
Get a specific tournament and info for its team

Request

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

Responses

🟢200OK
application/json
Body
tournament
object (Tournament) 
required
The returned tournament
id
string 
required
The ID of the tournament
name
string 
required
The name of the tournament
description
string  | null 
optional
The description of the tournament, seems to be unused in favor of additionalFields.description
priority
integer  | null 
optional
type
enum<string> 
required
The type of tournament
Allowed value:
tournament
avatar
string  | null 
required
The group avatar URL that the tournament is in or a Guilded asset for the game being played (starting with /asset/)
banner
string  | null 
required
The group banner URL that the tournament is in or a Guilded asset for the game being played (starting with /asset/)
logo
string  | null 
optional
Unknown
teamId
string 
required
The team ID that the tournament is in
gameId
integer  | string 
required
The game being played in the tournament
>= 10100<= 477074
visibilityTeamRoleId
integer  | null 
optional
The role ID required to see the tournament
membershipTeamRoleId
integer  | null 
optional
The role ID required to join the tournament
isBase
boolean 
optional
Unknown
additionalGameInfo
object 
optional
createdBy
string 
optional
The user ID who created the tournament
createdAt
string <date-time>
optional
When the tournament was created
updatedBy
string  | null 
optional
The user ID who last updated the tournament
updatedAt
string <date-time> | null 
optional
When the tournament was last updated
deletedAt
string <date-time> | null 
optional
When the tournament was deleted
customReactionId
integer  | null 
optional
The ID of the emoji associated with the tournament
isPublic
boolean 
optional
Whether the tournament is public
archivedAt
string <date-time> | null 
optional
When the tournament was archived
archivedBy
string  | null 
optional
The user ID who archived the tournament
tournamentId
string 
deprecated
The ID of the tournament (duplicate of id)
isPublished
boolean 
optional
Whether the tournament is published
additionalFields
object  | null 
optional
More fields for the tournament
minRosterSize
integer 
optional
Minimum roster size required for the tournament to begin
maxRosterSize
integer 
optional
Maximum roster size for the tournament
maxParticipants
integer  | null 
optional
Maximum number of participants for the tournament, null if no maximum
customFormId
integer  | null 
optional
The ID of the form associated with the tournament
startDate
string <date-time>
required
When the tournament begins
endDate
string <date-time>
required
When the tournament ends
teamSize
integer 
optional
Unknown
customLineupFormId
integer  | null 
optional
The ID of another form associated with the tournament
tournamentMembers
array [object {5}]  | null 
optional
The members of the tournament
isFeatured
boolean  | null 
optional
Whether the tournament is featured (assume false if null)
staffMembers
array [object {2}] 
optional
Staff members who will be available for the tournament
team
object (Team) 
required
The team that the tournament is in
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
{
  "tournament": {
    "id": "string",
    "name": "string",
    "description": "string",
    "priority": 0,
    "type": "tournament",
    "avatar": "string",
    "banner": "string",
    "logo": "string",
    "teamId": "string",
    "gameId": 10100,
    "visibilityTeamRoleId": 0,
    "membershipTeamRoleId": 0,
    "isBase": true,
    "additionalGameInfo": {},
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "customReactionId": 0,
    "isPublic": true,
    "archivedAt": "2019-08-24T14:15:22Z",
    "archivedBy": "string",
    "tournamentId": "string",
    "isPublished": true,
    "additionalFields": {
      "prizes": {
        "title": "string",
        "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"
              }
            ]
          }
        }
      },
      "sponsors": {
        "title": "string",
        "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"
              }
            ]
          }
        }
      },
      "description": "string"
    },
    "minRosterSize": 0,
    "maxRosterSize": 0,
    "maxParticipants": 0,
    "customFormId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "teamSize": 0,
    "customLineupFormId": 0,
    "tournamentMembers": [
      {
        "teamId": "string",
        "userId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "tournamentId": "string",
        "membershipRole": "string"
      }
    ],
    "isFeatured": true,
    "staffMembers": [
      {
        "userId": "string",
        "membershipRole": "string"
      }
    ]
  },
  "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": [
      {}
    ]
  }
}
Modified at 2024-06-10 14:16:22
Previous
Get Tournament
Next
Get Tournament Any Bracket Confirmed
Built with