Skip to main content

API reference

Clans

Fixture clan operations.


GET

/clans/{clanId}

Returns the fixture clan record. Field names below are placeholders and will not match the real API.

Path parameters

Path parameters for GET /clans/{clanId}
NameTypeRequiredDescription
clanIdstringrequiredThe clan's identifier.

Query parameters

Query parameters for GET /clans/{clanId}
NameTypeRequiredDescription
includestringranksmembersmedalsoptionalExtra relations to embed in the response.
local HttpService = game:GetService("HttpService")

local response = HttpService:RequestAsync({
    Url = "https://api.example.invalid/v0/clans/CLAN_ID",
    Method = "GET",
    Headers = {
        ["Authorization"] = "Bearer YOUR_CLAN_API_KEY",
    },
})

if response.Success then
    print(HttpService:JSONDecode(response.Body))
else
    warn(response.StatusCode, response.Body)
end

The clan.

{
  "id": "CLAN_ID",
  "name": "Example Clan",
  "clanType": "NORMAL",
  "memberCount": 42
}