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

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
      }
    }
  ]
}