SportCenter

Retrieves the collection of SportCenter resources.

Retrieves the collection of SportCenter resources.

get/sport_centers/inventories

Request

  • Base URL: https://api.spash.com
  • URL: https://api.spash.com/sport_centers/inventories
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

paginationboolean

Enable or disable pagination

order[id]'asc' | 'desc'
order[name]'asc' | 'desc'
order[reference]'asc' | 'desc'
order[city]'asc' | 'desc'
order[country.id]'asc' | 'desc'
order[updatedAt]'asc' | 'desc'
order[createdAt]'asc' | 'desc'
namestring
tags.referencestring
tags.reference[]string[]
statusstring
status[]string[]
idinteger
id[]integer[]
referenceinteger
reference[]integer[]
fields.idinteger
fields.id[]integer[]
visibleboolean
monitoringOnboolean
sportsCoboolean
searchstring
createdAt[before]string
createdAt[strictly_before]string
createdAt[after]string
createdAt[strictly_after]string
updatedAt[before]string
updatedAt[strictly_before]string
updatedAt[after]string
updatedAt[strictly_after]string

Response

SportCenter collection

idinteger
namestring required
addressstring required
postCodestring required
citystring required
phonestring nullable
websitestring nullable
facebookPagestring nullable
coordinatesstring[] nullable
visibleboolean
bookingProvider'le_five_4padel' | 'powerleague' | 'null' nullable
bookingProviderIdinteger nullable
monitoringOnboolean
pedroVersionTargetstring required
timeZonestring
availableHi5Colorsstring[]
inscriptionPostmatchUnifiedboolean
customerPostmatchUnifiedboolean
buddyGroupEnabledboolean
availableMenusstring[]
pedroWebsitestring nullable
liveEnableboolean
durationChoicesstring[]
timeboardConfigstring[]
validDurationLimitinteger
apiURLstring ipv4
codeAdmininteger
concurrentHi5SessionsMaxinteger
interfacesLockedboolean
videoExpiresAfterinteger

Defines how long will videos be retained in days.

language'fr' | 'en' | 'es' | 'it' | 'de' required
distanceUnite'km' | 'mile' required
inscriptionHi5Type'email-name' | 'name' required
registrationTypestring
competitionEmailNotificationEnabledboolean
sportsCoboolean
advertMobileClipVideoUrlstring nullable

Url of the advert Mobile clip video. To remove, set it to null.

keepVideosHoursDurationinteger nullable

How long (in hours) do we keep videos before deletion once the session is played. 0: Delete them right now, [n]: Keep n hours after actualEndedAt, null: Never delete.

logoImageUrlstring nullable

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

sportsstring[]
status'in_preparation' | 'active' | 'terminated' | 'in_dispute' | 'out_of_scope'
notesstring nullable

Notes about the sport center, used by BOO users.

quickSquadEnabledboolean

Enable the quick squad feature. This feature allows to create players on the fly in Pedro Foot v2.

extraTimeEnabledboolean

Enable the extra time feature. This feature allows to add extra time to the end of a session.

multiLiveAvailableboolean

Enable multiple simultaneous live streams.

stickerValidityPeriodEnabledboolean
createdAtstring date-time
updatedAtstring date-time
referenceinteger
hi5boolean

Check if the sport center has some fields in hi5.

departmentReferencestring nullable

For French sport centers, get the department's id.

salesRepresentativesstring
managersCollectionSportCenterSportCenterReadRead
webServerComputerIdinteger nullable
camerasURLSstring[]
bucketNamestring
logosURLstring nullable
liveStreamKeysConfiguredboolean
liveStreamChannelsConfiguredboolean
subscribedOptionsstring[]
fiveIdinteger nullable

Example response

[
  {
    "coordinates": [
      0,
      0
    ],
    "visible": true,
    "pedroVersionTarget": "undefined",
    "timeZone": "Europe/Paris",
    "availableHi5Colors": [
      "blue",
      "orange"
    ],
    "availableMenus": [
      "config",
      "field"
    ],
    "durationChoices": [
      3600,
      5400,
      7200
    ],
    "timeboardConfig": [
      "clock",
      "timer"
    ],
    "validDurationLimit": 600,
    "apiURL": "192.168.8.9",
    "codeAdmin": 1987,
    "concurrentHi5SessionsMax": 1,
    "videoExpiresAfter": 60,
    "language": "en",
    "distanceUnite": "km",
    "inscriptionHi5Type": "email-name",
    "registrationType": "public",
    "competitionEmailNotificationEnabled": true,
    "keepVideosHoursDuration": 24,
    "status": "in_preparation",
    "extraTimeEnabled": true,
    "country": {
      "currency": "EUR"
    },
    "fields": [
      {
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      }
    ],
    "computers": [
      {
        "type": "web_server",
        "field": {
          "createdAt": "CURRENT_TIMESTAMP",
          "updatedAt": "CURRENT_TIMESTAMP"
        },
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      }
    ],
    "tags": [
      {
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      }
    ],
    "ngtvSessionEventTypes": [
      {
        "position": 1,
        "color": "green",
        "duration": 30,
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      }
    ],
    "storageServer": {
      "domain": "ngtvexperience.com",
      "type": "minio",
      "awsRegion": "eu-west-3",
      "port": 9000,
      "country": {
        "currency": "EUR"
      },
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "liveStreamChannels": [
      {
        "currentSession": {
          "createdAt": "CURRENT_TIMESTAMP",
          "updatedAt": "CURRENT_TIMESTAMP"
        },
        "type": "twitch",
        "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.