FiveSession

Retrieves the collection of FiveSession resources.

Retrieves the collection of FiveSession resources.

get/five_sessions

Request

  • Base URL: https://api.spash.com
  • URL: https://api.spash.com/five_sessions
  • 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

startedAt[before]string
startedAt[strictly_before]string
startedAt[after]string
startedAt[strictly_after]string
localStartedAt[before]string
localStartedAt[strictly_before]string
localStartedAt[after]string
localStartedAt[strictly_after]string
endedAt[before]string
endedAt[strictly_before]string
endedAt[after]string
endedAt[strictly_after]string
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
idinteger
id[]integer[]
fiveIdinteger
fiveId[]integer[]
sportCenter.idinteger
sportCenter.id[]integer[]
sportCenter.referenceinteger
sportCenter.reference[]integer[]
order[id]'asc' | 'desc'
order[fiveId]'asc' | 'desc'
order[bookingId]'asc' | 'desc'
order[type]'asc' | 'desc'
order[status]'asc' | 'desc'
order[field.name]'asc' | 'desc'
order[sportCenter.name]'asc' | 'desc'
order[startedAt]'asc' | 'desc'
order[localStartedAt]'asc' | 'desc'
order[createdAt]'asc' | 'desc'
order[updatedAt]'asc' | 'desc'
searchstring

Response

FiveSession collection

idinteger
namestring nullable
typestring
fiveIdinteger required
bookingIdinteger nullable
statusstring
startedAtstring date-time nullable
localStartedAtstring date-time nullable
endedAtstring date-time nullable
localEndedAtstring date-time nullable
createdAtstring date-time
updatedAtstring date-time
gameSheetUrlstring

Example response

[
  {
    "type": "standard",
    "status": "not_played",
    "field": {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "sportCenter": {
      "coordinates": [
        0,
        0
      ],
      "visible": true,
      "pedroVersionTarget": "undefined",
      "timeZone": "Europe/Paris",
      "durationChoices": [
        3600,
        5400,
        7200
      ],
      "language": "en",
      "distanceUnite": "km",
      "country": {
        "currency": "EUR"
      },
      "tablets": [
        {
          "createdAt": "CURRENT_TIMESTAMP",
          "updatedAt": "CURRENT_TIMESTAMP"
        }
      ],
      "tags": [
        {
          "createdAt": "CURRENT_TIMESTAMP",
          "updatedAt": "CURRENT_TIMESTAMP"
        }
      ],
      "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.