Local Sport Hero

Get chat Deprecated

GET /1/chats/{id}

Get chat

Path parameters

  • id string Required

    The chat id.

Responses

  • 200 application/json

    The requested chat.

    Hide response attribute Show response attribute object
    • chat object
      Hide chat attributes Show chat attributes object
      • id string Required
      • name string
      • expiryDate string
      • membership object
        Hide membership attributes Show membership attributes object
        • id string Required
        • threadId string Required
        • threadType 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
        • cursor string Required
        • muted boolean Required
        • expiryDate string
      • newMessages array[object] Required
        Hide newMessages attributes Show newMessages attributes object
        • id string Required
        • type string Required
        • title string
        • text string Required
        • date string Required
        • sender string
        • imageUrl string
        • memberId string
        • userId string
        • chatId string Required
        • threadId string Required
        • checkin object
          Hide checkin attributes Show checkin attributes object
          • id string Required
          • imageUrl string
          • tags array[string] Required
GET /1/chats/{id} 
curl \
 --request GET 'https://api.localsporthero.com/1/chats/{id}'
Response examples (200) 
{
  "chat": {
    "id": "df2cd71c-d006-4a46-8e2a-d09503273f07",
    "name": "BoersBootyCamp",
    "expiryDate": "2022-05-02T11:00:00.000Z",
    "membership": {
      "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
      "threadId": "85756F43-63E4-4B18-A978-B04039466509",
      "threadType": "direct",
      "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
        }
      },
      "cursor": "2022-05-02T11:00:00.000Z",
      "muted": false,
      "expiryDate": "2022-05-02T11:00:00.000Z"
    },
    "newMessages": [
      {
        "id": "85362399-38e1-4255-87a0-f3f984ed16d9",
        "type": "system, user or generated",
        "title": "Update",
        "text": "Hey ola!",
        "date": "2022-05-02T11:00:00.000Z",
        "sender": "Sebassie",
        "imageUrl": "https://example.org/image.jpg",
        "memberId": "85362399-38e1-4255-87a0-f3f984ed16d9",
        "userId": "85362399-38e1-4255-87a0-f3f984ed16d9",
        "chatId": "85362399-38e1-4255-87a0-f3f984ed16d8",
        "threadId": "85362399-38e1-4255-87a0-f3f984ed16d8",
        "checkin": {
          "id": "85362399-38e1-4255-87a0-f3f984ed16d8",
          "imageUrl": "https://example.org/image.jpg",
          "tags": [
            "15 km, 200 push ups"
          ]
        }
      }
    ]
  }
}