Player

Retrieves the collection of Player resources.

Retrieves the collection of Player resources.

get/players

Request

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

enabledboolean
idinteger
id[]integer[]
favoriteSportCenter.idinteger
favoriteSportCenter.id[]integer[]
playerSportCenters.sportCenter.idinteger
playerSportCenters.sportCenter.id[]integer[]
order[id]'asc' | 'desc'
order[email]'asc' | 'desc'
order[name]'asc' | 'desc'
order[facebookId]'asc' | 'desc'
order[createdAt]'asc' | 'desc'
order[updatedAt]'asc' | 'desc'
emailstring
namestring
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

Player collection

idinteger
namestring required
language'en' | 'es' | 'fr' | 'it'
gender'M' | 'F'
scope'public' | 'private'
lastLoggedAtstring date-time nullable
avatarImageUrlstring nullable

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

createdAtstring date-time
updatedAtstring date-time
managerboolean

Is player a manager of a sportCenter?

coachboolean

Is player a coach of a sportCenter?

managedSportCentersCollectionPlayerPlayerReadRead
playerSportsCollectionPlayerPlayerReadRead

Example response

[
  {
    "language": "en",
    "gender": "M",
    "scope": "public",
    "favoriteSportCenter": {
      "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"
    },
    "playerSportCenters": [
      {
        "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"
        },
        "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.