Competition

Retrieves a Competition resource.

Retrieves a Competition resource.

get/competitions/{id}

Request

  • Base URL: https://api.spash.com
  • URL: https://api.spash.com/competitions/{id}
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

idstring required

Competition identifier

Response

Competition resource

idinteger
namestring
visibleboolean
groupsTotalinteger
twoLeggedboolean
sessionDurationinteger
breakDurationinteger
expectedStartingAtstring date-time nullable
timeSlotsstring[]
timeBetweenRoundsinteger
statusstring
priceinteger

Price without taxes.

teamsLimitNumberinteger nullable
sessionsGeneratedboolean
victoryPointsinteger
defeatPointsinteger
drawPointsinteger
forfeitPointsinteger
withStatsboolean
firstLogoImageUrlstring nullable

Url of the first logo image. To remove, set it to null.

secondLogoImageUrlstring nullable

Url of the second logo image. To remove, set it to null.

foulsForPenaltyinteger nullable

How many fouls should be conceded to get a penalty.

bookingProviderIdinteger nullable
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "groupsTotal": 1,
  "sessionDuration": 3000,
  "breakDuration": 300,
  "status": "not_played",
  "victoryPoints": 3,
  "drawPoints": 1,
  "competitionTeams": [
    {
      "groupReference": "A",
      "ranking": 1,
      "team": {
        "primaryColor": "#FFFFFF",
        "secondaryColor": "#FFFFFF",
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      },
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    }
  ],
  "reservedFields": [
    {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    }
  ],
  "sportCenter": {
    "coordinates": [
      0,
      0
    ],
    "visible": true,
    "timeZone": "Europe/Paris",
    "durationChoices": [
      3600,
      5400,
      7200
    ],
    "language": "en",
    "distanceUnite": "km",
    "country": {
      "currency": "EUR"
    },
    "tags": [
      {
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      }
    ],
    "createdAt": "CURRENT_TIMESTAMP",
    "updatedAt": "CURRENT_TIMESTAMP"
  },
  "tags": [
    {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    }
  ],
  "createdAt": "CURRENT_TIMESTAMP",
  "updatedAt": "CURRENT_TIMESTAMP"
}

Changes

No recorded changes to this operation across all 1 revision of this API.