/

GET 
/companies

/

Request

Query Parameters

hasCustomDomain boolean
plan string

Possible values: [full, lite]

search string
skip number
take number
tournamentId number

Header Parameters

x-futbolprode-company string

Optional tenant override - for resellers only.

Responses

200

application/json

Schema

Schema

data object[]
Array [
allowExceedMaxUsers booleanrequired
allowMobileApp booleanrequired
allowUserEmailEdit booleanrequired
allowUserNameEdit booleanrequired
appCustomDomain string
appPath string
areas object[]required
Array [
childrenAreas objectrequired
[Circular reference to Area]
company objectrequired
[Circular reference to Company]
id numberrequired
name stringrequired
parentArea object
[Circular reference to Area]
]
banners object[]
Array [
desktopImageUrl string
link string
mobileImageUrl string
type stringrequired
Possible values: [superior, middle, side]
]
code stringrequired
combinedRoundsRankingDefinitions string[]required
comingSoonModeBackgroundImageUrl string
comingSoonModeIsEnabled booleanrequired
comingSoonModeTextColor string
customColors objectrequired
customFontFamily string
customTeams object
color string
country objectrequired
alpha2Code string
flagUrl string
id numberrequired
name stringrequired
teams string[]required
tournaments string[]required
externalId string
id numberrequired
logoUrl string
name stringrequired
owner object
[Circular reference to Company]
customTournaments object
country objectrequired
alpha2Code string
flagUrl string
id numberrequired
name stringrequired
teams string[]required
tournaments string[]required
defaultRssFeeds string[]
externalId string
hasPenalties boolean
hasTwoWayMatches booleanrequired
id numberrequired
importNewMatchesWithPenalties booleanrequired
isActive boolean
logoUrl string
matchDuration number
name stringrequired
owner object
[Circular reference to Company]
rounds object[]required
season string
showNoMoreRoundsWarning booleanrequired
startDate string
deletedAt date-time
disableAreaRankings booleanrequired
disableAreaRankingsMainPageSummary booleanrequired
disableExtraPredictions booleanrequired
disableGoogleLogin booleanrequired
disableInitialTour booleanrequired
disableInternalRankings booleanrequired
disableNews booleanrequired
disableNewsFromHome booleanrequired
disableRankingsMainPageCards booleanrequired
disableRankingsMainPageSummary booleanrequired
disableRankingsTable booleanrequired
disableRankingsUserNames booleanrequired
disableRegister booleanrequired
disableTournamentDetails booleanrequired
disableTrivias booleanrequired
dreamFinalsSettings object[]required
Array [
awardedPoints numberrequired
awardedPositions numberrequired
company objectrequired
[Circular reference to Company]
id numberrequired
isEnabled booleanrequired
limitRound objectrequired
[Circular reference to Round]
tournament objectrequired
[Circular reference to Tournament]
]
extraFields object[]required
Array [
group object
id stringrequired
kind stringrequired
order numberrequired
isRequired booleanrequired
locationScope object
countries object[]
Array [
code stringrequired
name stringrequired
]
states object[]
Array [
code stringrequired
name stringrequired
]
name stringrequired
onlyForAreas number[]
type stringrequired
]
featureSettings objectrequired
areas objectrequired
minUsersForAreaRanking numberrequired
selfAssignOnSignUp booleanrequired
community objectrequired
enabled booleanrequired
postAllowedContent stringrequired
Possible values: [textOnly, textAndImage]
postAuthorMinRole stringrequired
Possible values: [player, admin, reseller, manager]
googleServicesConfig objectrequired
adSenseClientId string
allowSearchEngineIndexing booleanrequired
analyticsTrackingId string
id numberrequired
initialConfigLastStep stringrequired
invitations string[]required
isologoUrl string
isReseller booleanrequired
loginAnnouncementIsEnabled booleanrequired
loginAnnouncementSeverity string
loginImageUrl string
loginLogoUrl string
loginStrategy numberrequired
Possible values: [0, 1]
logoUrl string
mainPageAnnouncementIsEnabled booleanrequired
mainPageAnnouncementSeverity string
managerUsers array[]
maxUsersAmount numberrequired
name stringrequired
news string[]required
purchasedGames objectrequired
prode booleanrequired
trivia booleanrequired
purchasedPlan stringrequired
Possible values: [full, lite]
requiresEmailVerification booleanrequired
rssFeeds string[]
skipLoginToken string
theme objectrequired
tournaments object[]required
Array [
country objectrequired
alpha2Code string
flagUrl string
id numberrequired
name stringrequired
teams string[]required
tournaments string[]required
defaultRssFeeds string[]
externalId string
hasPenalties boolean
hasTwoWayMatches booleanrequired
id numberrequired
importNewMatchesWithPenalties booleanrequired
isActive boolean
logoUrl string
matchDuration number
name stringrequired
owner object
[Circular reference to Company]
rounds object[]required
season string
showNoMoreRoundsWarning booleanrequired
startDate string
]
users string[]required
usersCount numberrequired
]
pagination object
count number
page number
skip number
take number

Example (from schema)

{
  "data": [
    {
      "allowExceedMaxUsers": true,
      "allowMobileApp": true,
      "allowUserEmailEdit": true,
      "allowUserNameEdit": true,
      "appCustomDomain": "string",
      "appPath": "string",
      "areas": [
        {
          "childrenAreas": {},
          "company": {},
          "id": 0,
          "name": "string",
          "parentArea": {}
        }
      ],
      "banners": [
        {
          "desktopImageUrl": "string",
          "link": "string",
          "mobileImageUrl": "string",
          "type": "superior"
        }
      ],
      "code": "string",
      "combinedRoundsRankingDefinitions": [
        "string"
      ],
      "comingSoonModeBackgroundImageUrl": "string",
      "comingSoonModeIsEnabled": true,
      "comingSoonModeTextColor": "string",
      "customColors": {},
      "customFontFamily": "string",
      "customTeams": {
        "color": "string",
        "country": {
          "alpha2Code": "string",
          "flagUrl": "string",
          "id": 0,
          "name": "string",
          "teams": [
            "string"
          ],
          "tournaments": [
            "string"
          ]
        },
        "externalId": "string",
        "id": 0,
        "logoUrl": "string",
        "name": "string",
        "owner": {}
      },
      "customTournaments": {
        "country": {
          "alpha2Code": "string",
          "flagUrl": "string",
          "id": 0,
          "name": "string",
          "teams": [
            "string"
          ],
          "tournaments": [
            "string"
          ]
        },
        "defaultRssFeeds": [
          "bolavip_argentina",
          "direct_tv_sports"
        ],
        "externalId": "string",
        "hasPenalties": true,
        "hasTwoWayMatches": true,
        "id": 0,
        "importNewMatchesWithPenalties": true,
        "isActive": true,
        "logoUrl": "string",
        "matchDuration": 0,
        "name": "string",
        "owner": {},
        "rounds": [
          {}
        ],
        "season": "string",
        "showNoMoreRoundsWarning": true,
        "startDate": "string"
      },
      "deletedAt": "2026-04-25T05:24:14.956Z",
      "disableAreaRankings": true,
      "disableAreaRankingsMainPageSummary": true,
      "disableExtraPredictions": true,
      "disableGoogleLogin": true,
      "disableInitialTour": true,
      "disableInternalRankings": true,
      "disableNews": true,
      "disableNewsFromHome": true,
      "disableRankingsMainPageCards": true,
      "disableRankingsMainPageSummary": true,
      "disableRankingsTable": true,
      "disableRankingsUserNames": true,
      "disableRegister": true,
      "disableTournamentDetails": true,
      "disableTrivias": true,
      "dreamFinalsSettings": [
        {
          "awardedPoints": 0,
          "awardedPositions": 0,
          "company": {},
          "id": 0,
          "isEnabled": true,
          "limitRound": {},
          "tournament": {}
        }
      ],
      "extraFields": [
        {
          "group": {
            "id": "string",
            "kind": "string",
            "order": 0
          },
          "isRequired": true,
          "locationScope": {
            "countries": [
              {
                "code": "string",
                "name": "string"
              }
            ],
            "states": [
              {
                "code": "string",
                "name": "string"
              }
            ]
          },
          "name": "string",
          "onlyForAreas": [
            0
          ],
          "type": "string"
        }
      ],
      "featureSettings": {
        "areas": {
          "minUsersForAreaRanking": 0,
          "selfAssignOnSignUp": true
        },
        "community": {
          "enabled": true,
          "postAllowedContent": "textOnly",
          "postAuthorMinRole": "player"
        }
      },
      "googleServicesConfig": {
        "adSenseClientId": "string",
        "allowSearchEngineIndexing": true,
        "analyticsTrackingId": "string"
      },
      "id": 0,
      "initialConfigLastStep": "string",
      "invitations": [
        "string"
      ],
      "isologoUrl": "string",
      "isReseller": true,
      "loginAnnouncementIsEnabled": true,
      "loginAnnouncementSeverity": "string",
      "loginImageUrl": "string",
      "loginLogoUrl": "string",
      "loginStrategy": 0,
      "logoUrl": "string",
      "mainPageAnnouncementIsEnabled": true,
      "mainPageAnnouncementSeverity": "string",
      "managerUsers": [
        [
          null
        ]
      ],
      "maxUsersAmount": 0,
      "name": "string",
      "news": [
        "string"
      ],
      "purchasedGames": {
        "prode": true,
        "trivia": true
      },
      "purchasedPlan": "full",
      "requiresEmailVerification": true,
      "rssFeeds": [
        "bolavip_argentina",
        "direct_tv_sports"
      ],
      "skipLoginToken": "string",
      "theme": {},
      "tournaments": [
        {
          "country": {
            "alpha2Code": "string",
            "flagUrl": "string",
            "id": 0,
            "name": "string",
            "teams": [
              "string"
            ],
            "tournaments": [
              "string"
            ]
          },
          "defaultRssFeeds": [
            "bolavip_argentina",
            "direct_tv_sports"
          ],
          "externalId": "string",
          "hasPenalties": true,
          "hasTwoWayMatches": true,
          "id": 0,
          "importNewMatchesWithPenalties": true,
          "isActive": true,
          "logoUrl": "string",
          "matchDuration": 0,
          "name": "string",
          "owner": {},
          "rounds": [
            {}
          ],
          "season": "string",
          "showNoMoreRoundsWarning": true,
          "startDate": "string"
        }
      ],
      "users": [
        "string"
      ],
      "usersCount": 0
    }
  ],
  "pagination": {
    "count": 0,
    "page": 0,
    "skip": 0,
    "take": 0
  }
}

Loading...