Get Featured Tournaments

Get a list of featured public tournaments

Responses

🟢200OK

application/json

Body

tournaments

array[object (Tournament) {37}]

required

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

teams

array [object {5}]

required

string

required

The ID of the team

name

string

required

The name of the team

isPro

boolean

optional

Whether the team is "pro"

isVerified

boolean

optional

Whether the team is verified

profilePicture

string <uri> | null

optional

The avatar URL of the team

Example

{
    "tournaments": [
        {
            "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": {}
                                                        }
                                                    ]
                                                }
                                            ]
                                        }
                                    ],
                                    "": "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": {}
                                                        }
                                                    ]
                                                }
                                            ]
                                        }
                                    ],
                                    "": "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"
                }
            ]
        }
    ],
    "teams": [
        {
            "id": "string",
            "name": "string",
            "isPro": true,
            "isVerified": true,
            "profilePicture": "http://example.com"
        }
    ]
}

Request

Request samples

Responses