List clubs with search and pagination

GET

/api/v1/clubs

curl --request GET \
  --url 'https://internal.myscore.live/api/v1/api/v1/clubs?page=1&perPage=20&sortBy=createdAt&sortOrder=asc'

• Production
• Development

Returns a paginated list of clubs, optionally filtered by search query.

Parameters

Query Parameters

page

number

default: 1 >= 1

Example

1

Page number (1-indexed)

perPage

number

default: 20 >= 1 <= 100

Example

20

Number of items per page

sortBy

string

Example

createdAt

Field to sort by

sortOrder

string

default: desc

Allowed values: asc desc

Example

desc

Sort order

search

string

Search by club name

Responses

200

List of clubs

Media type application/json

object

data

required

Array of club records

Array<object>

object

id

required

Unique club identifier

string

name

required

Club name

string

address

Club address

string

nullable

logo

Club logo URL

string format: uri

nullable

createdAt

required

Record creation timestamp

string format: date-time

updatedAt

required

Record last update timestamp

string format: date-time

meta

required

Pagination metadata

object

total

required

Total number of items

number

page

required

Current page number (1-indexed)

number

>= 1

perPage

required

Number of items per page

number

>= 1

totalPages

required

Total number of pages

number

>= 1

hasNextPage

required

Whether there is a next page

boolean

hasPreviousPage

required

Whether there is a previous page

boolean

Example

{
  "data": [
    {
      "id": "club_a1b2c3d4",
      "name": "Real Club de Tenis Barcelona",
      "address": "Carrer de la Bosch i Gimpera, 5, 08034 Barcelona, Spain",
      "logo": "https://cdn.myscore.com/clubs/rct-barcelona.png",
      "createdAt": "2024-08-15T10:30:00.000Z",
      "updatedAt": "2024-09-01T14:20:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "perPage": 20,
    "totalPages": 5,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

429

Rate limit exceeded