Params

NameTypeRequirenessDefault valueDescription
bookingsUidsstringoptionalnoneList of comma separated booking UIDs
threadIdsstringoptionalnoneList of comma separated thread Ids
fromDatestringoptionalnoneYYYY-MM-DD Start of the updated period. If only this date is provided, the toDate will be automatically set.
toDatestringoptionalnoneYYYY-MM-DD End of the updated period. If only this date is provided, the fromDate will be automatically set.
pageintoptional1Page number for pagination

Description

Retrieve threads with their messages.

Only one parameter of the 3 optional ones will be returned. (bookingsUids / threadIds / fromDate || toDate)

This endpoint requires the following scope: messaging

Request sample

{
  "fromDate": "2024-11-19",
  "toDate": "2024-11-20",
  "page": 1
}

Response

{
  "data": [
    {
      "threadId": 1033478,
      "platformType": "airgms",
      "platformUserId": "HMSVLQZNSF5SS2XC",
      "hostUid": "HMSVLQZNSF5SS2XC_airgms",
      "platformGuestId": "BHY8E4CPSM8G0SG4WO0KGS40O",
      "guestUid": "BHY8E4CPSM8G0SG4WO0KGS40O_airgms",
      "createDttm": "2024-02-16 05:18:27",
      "updateDttm": "2024-11-20 13:55:28",
      "listingId": "HMSVLR16ZR7RZP8S",
      "listingUid": "HMSVLR16ZR7RZP8S_airgms_HMSVLQZNSF5SS2XC",
      "reservationCode": "DRT1N2BN",
      "bookingUid": "DRT1N2BN_airgms_HMSVLQZNSF5SS2XC",
      "lastMessageDttm": "2024-11-20 13:55:28",
      "messages": [
        {
          "messageId": 1409180597,
          "platformSenderUserId": "HMSVLQZNSF5SS2XC",
          "senderUid": "HMSVLQZNSF5SS2XC_airgms",
          "messageText": "Api test",
          "messageDttm": "2024-11-20 13:55:28",
          "files": [
            {
              "type": "image\/jpeg",
              "name": "gora2.jpg",
              "url": "https:\/\/lh3.googleusercontent.com\/F-zD8J4HOTz-pydfq0W-F9ybPOoFAiRgyduXOqzPgui7gl4XcGM4Tui5XQSG-0xqsAClHgxhk2iwti1aS4LDSSb90M4yMw1Z2dtlaQ=s0",
              "imageId": 1257,
              "templateId": 99839745
            },
            {
              "type": "image\/jpeg",
              "name": "jon.jpg",
              "url": "https:\/\/lh3.googleusercontent.com\/KkgMHwiCyKvTdZpIfuD1zAVZ7oiMFx3Peu2Hsc29xqT3_hAakM19pTbT0m_G7Mf3sAKIsjhD9P-Edr8QjYSpeyA8yjIY2miSqIKc=s0",
              "imageId": 1258,
              "templateId": 99839745
            }
          ]
        },
        {
          "messageId": 1409179135,
          "platformSenderUserId": "HMSVLQZNSF5SS2XC",
          "senderUid": "HMSVLQZNSF5SS2XC_airgms",
          "messageText": "Hello !",
          "messageDttm": "2024-07-18 03:24:42",
          "files": []
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "hasNextPage": false
  }
}