Get club suggestions

GET /1/clubs/suggestions

Get club suggestions

Query parameters

  • latitude number

    Latitude of the location to get suggestions for.

  • longitude number

    Longitude of the location to get suggestions for.

  • radius integer

    The radius in meters.

    Default value is 10000.

  • limit integer

    The limit of results.

    Default value is 10.

Responses

  • 200 application/json

    Get club suggestions based on coordinate.

    Hide response attribute Show response attribute object
    • clubs array[object]
      Hide clubs attributes Show clubs attributes object
      • id string Required
      • name string Required
      • summary string Required
      • private boolean Required
      • headerUrl string
      • membership object
        Hide membership attributes Show membership attributes object
        • id string Required
        • user object Required
          Hide user attributes Show user attributes object
          • id string Required
          • nickname string Required
          • fullName string
          • email string Required
          • language string Required
          • startDate string Required
          • imageUrl string
          • waitingListValue number Required
          • notificationsEnabled boolean Required
          • notifyDaysBefore array[integer] Required
          • private boolean Required
          • yourFriendship object
            Hide yourFriendship attributes Show yourFriendship attributes object
            • id string Required
            • status string Required
            • date string Required
            • muted boolean
          • theirFriendship object
            Hide theirFriendship attributes Show theirFriendship attributes object
            • id string Required
            • status string Required
            • date string Required
            • muted boolean
        • role string Required
        • startDate string Required
      • chatId string
      • request object
        Hide request attributes Show request attributes object
        • id string Required
        • user object Required
          Hide user attributes Show user attributes object
          • id string Required
          • nickname string Required
          • fullName string
          • email string Required
          • language string Required
          • startDate string Required
          • imageUrl string
          • waitingListValue number Required
          • notificationsEnabled boolean Required
          • notifyDaysBefore array[integer] Required
          • private boolean Required
          • yourFriendship object
            Hide yourFriendship attributes Show yourFriendship attributes object
            • id string Required
            • status string Required
            • date string Required
            • muted boolean
          • theirFriendship object
            Hide theirFriendship attributes Show theirFriendship attributes object
            • id string Required
            • status string Required
            • date string Required
            • muted boolean
        • clubId string Required
        • date string Required
      • timeZoneId string
      • location object
        Hide location attributes Show location attributes object
        • city string
        • countryCode string
        • latitude number
        • longitude number
GET /1/clubs/suggestions
curl \
 --request GET 'https://api.localsporthero.com/1/clubs/suggestions'
Response examples (200)
{
  "clubs": [
    {
      "id": "df2cd71c-d006-4a46-8e2a-d09503273f07",
      "name": "Arco's Angels",
      "summary": "Een leuke club helden op sokken bij elkaar.",
      "private": false,
      "headerUrl": "https://example.org/image.jpg",
      "membership": {
        "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
        "user": {
          "id": "1ab474d5-e1fa-4340-ba6a-5642e720ea6a",
          "nickname": "Stevertje",
          "fullName": "Stefan de Jong",
          "email": "stefandejong@gmail.com",
          "language": "nl",
          "startDate": "2022-05-02T11:00:00.000Z",
          "imageUrl": "https://example.org/image.jpg",
          "waitingListValue": 0,
          "notificationsEnabled": true,
          "notifyDaysBefore": [
            -1,
            1
          ],
          "private": false,
          "yourFriendship": {
            "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
            "status": "requested, accepted or blocked",
            "date": "2022-05-02T11:00:00.000Z",
            "muted": false
          },
          "theirFriendship": {
            "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
            "status": "requested, accepted or blocked",
            "date": "2022-05-02T11:00:00.000Z",
            "muted": false
          }
        },
        "role": "user or admin",
        "startDate": "2022-05-02T11:00:00.000Z"
      },
      "chatId": "df2cd71c-d006-4a46-8e2a-d09503273f05",
      "request": {
        "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
        "user": {
          "id": "1ab474d5-e1fa-4340-ba6a-5642e720ea6a",
          "nickname": "Stevertje",
          "fullName": "Stefan de Jong",
          "email": "stefandejong@gmail.com",
          "language": "nl",
          "startDate": "2022-05-02T11:00:00.000Z",
          "imageUrl": "https://example.org/image.jpg",
          "waitingListValue": 0,
          "notificationsEnabled": true,
          "notifyDaysBefore": [
            -1,
            1
          ],
          "private": false,
          "yourFriendship": {
            "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
            "status": "requested, accepted or blocked",
            "date": "2022-05-02T11:00:00.000Z",
            "muted": false
          },
          "theirFriendship": {
            "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
            "status": "requested, accepted or blocked",
            "date": "2022-05-02T11:00:00.000Z",
            "muted": false
          }
        },
        "clubId": "85362399-38e1-4255-87a0-f3f984ed16d9",
        "date": "2022-05-02T11:00:00.000Z"
      },
      "timeZoneId": "Europe/Amsterdam",
      "location": {
        "city": "Pijnacker",
        "countryCode": "NL",
        "latitude": 51.924419,
        "longitude": 4.477733
      }
    }
  ]
}