Article

Retrieves the collection of Article resources.

Retrieves the collection of Article resources.

get/articles

Request

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

idinteger
id[]integer[]
sportCenters.idinteger
sportCenters.id[]integer[]
sports.idinteger
sports.id[]integer[]
createdBy.idinteger
createdBy.id[]integer[]
videos.player.idinteger
videos.player.id[]integer[]
order[id]'asc' | 'desc'
order[createdAt]'asc' | 'desc'
order[updatedAt]'asc' | 'desc'
visibleFrom[before]string
visibleFrom[strictly_before]string
visibleFrom[after]string
visibleFrom[strictly_after]string
visibleTo[before]string
visibleTo[strictly_before]string
visibleTo[after]string
visibleTo[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
sports.namestring
titlestring
typestring
type[]string[]
scopestring
scope[]string[]
languagestring
language[]string[]
customizedboolean
visibleboolean

Filter articles by visibility

Response

Article collection

idinteger
titlestring required
contentstring required
type'news' | 'news_web' | 'contest' required
scope'local' | 'country' required
language'en' | 'es' | 'fr' | 'it' | 'sv' | 'de' required
visibleFromstring date-time required
visibleTostring date-time required
imageUrlstring nullable

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

createdAtstring date-time
updatedAtstring date-time

Example response

[
  {
    "language": "fr",
    "createdBy": {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "sportCenters": [
      {
        "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"
      }
    ],
    "countries": [
      {
        "currency": "EUR"
      }
    ],
    "createdAt": "CURRENT_TIMESTAMP",
    "updatedAt": "CURRENT_TIMESTAMP"
  }
]

Changes

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