Local Sport Hero

Get friends

GET /1/friends

Get friends

Query parameters

  • page integer

    Provide the page you want items for.

    Default value is 1.

  • per integer

    Provide the number of items per page.

    Default value is 10.

Responses

  • 200 application/json

    Get friends.

    Hide response attribute Show response attribute object
    • friends array[object]
      Hide friends attributes Show friends 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
GET /1/friends 
curl \
 --request GET 'https://api.localsporthero.com/1/friends'
Response examples (200) 
{
  "friends": [
    {
      "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
      }
    }
  ]
}