Skip to main content

Fetch Tournament List

Request

URI: /tournamentList

The request is executed using the POST method.

This method is used to fetch a list of tournaments based on the specified availability, either campaigns already assigned to the operator or campaigns available for the operator to join.

NameTypeRequiredDescription
Hash-AuthorizationstringYesA hash value generated from the request, used to verify its authenticity
More details can be found here

Request parameters

NameTypeRequiredDescription
availabilityintegerYesThe parameter defines which campaigns are returned when fetching the tournament list
Values:
  • available - Returns campaigns that are available for the operator to join but have not yet been assigned
  • assigned - Returns campaigns that the operator is already participating in
  • Example of Request

    Request: /tournamentList
    https://{base_url}/tournamentList?availability=available

    Response parameters

    NameTypeDescription
    idintegerUnique identifier of the tournament
    namestringName of the tournament
    start_datestringStart date and time of the tournament
    Date and time in ISO 8601 format
    end_datestringEnd date and time of the tournament
    Date and time in ISO 8601 format
    statusstringCurrent status of the tournament: Upcoming or Active
    typestringType of tournament: Tournament, Tournament With Drop, Drop Only, FS Tournament, Promo
    View description of tournament types Here
    providerarrayArray with data about the provider initiating the tournament
    provider.idintegerUnique ID of the provider
    provider.namestringName of the provider
    currenciesarrayArray with the list of supported currencies
    currencies.codestringCurrency code ISO 4217
    currencies.namestringCurrency name
    countriesarrayArray with the list of countries where the tournament is available
    countries.codestringCountry code in ISO 3166-1
    countries.namestringCountry name

    Example of a successful response

    Response: /tournamentList
    {
    "id": 8,
    "name": "Tournament of Champions",
    "start_date": "2025-05-15T00:01:00Z",
    "end_date": "2025-06-15T23:59:00Z",
    "status": "Active",
    "type": "TournamentWithDrop",
    "provider": {
    "id": 101,
    "name": "Pragmatic Play"
    },
    "currencies": [
    {
    "code": "ZAR",
    "name": "South African Rand"
    }
    ],
    "countries": [
    {
    "code": "ZA",
    "name": "South Africa"
    }
    ]
    }