Threads
Lists all messages under a given thread
For more information on Guest Communication, see https://api.rentalsunited.com/swagger/ui/index#!/Threads/Threads_SendMessage
Example messages from thread with host review, guest review, host response, guest response
GET threads/{id}/messages?messageLimit=4
[
{
"ID": 48573,
"ThreadID": 51558,
"Body": "{\"Creator\":\"host\",\"CategoryRatingsExtended\":[{\"Category\":\"cleanliness\",\"Rating\":4,\"Comment\":\"This is a test comment\",\"ReviewCategoryTags\":[\"HOST_REVIEW_GUEST_POSITIVE_NEAT_AND_TIDY\",\"HOST_REVIEW_GUEST_POSITIVE_KEPT_IN_GOOD_CONDITION\",\"HOST_REVIEW_GUEST_POSITIVE_TOOK_CARE_OF_GARBAGE\",\"CLEANLINESS_OTHER\"]},{\"Category\":\"respect_house_rules\",\"Rating\":4,\"ReviewCategoryTags\":[\"HOST_REVIEW_GUEST_NEGATIVE_ARRIVED_EARLY\",\"HOST_REVIEW_GUEST_NEGATIVE_STAYED_PAST_CHECKOUT\"]},{\"Category\":\"communication\",\"Rating\":4,\"Comment\":\"It is a test comment\",\"ReviewCategoryTags\":[\"HOST_REVIEW_GUEST_POSITIVE_HELPFUL_MESSAGES\",\"HOST_REVIEW_GUEST_POSITIVE_RESPECTFUL\",\"COMMUNICATION_OTHER\",\"HOST_REVIEW_GUEST_POSITIVE_ALWAYS_RESPONDED\"]}],\"IsPublished\":true,\"IsReviewRecommended\":true,\"IsExpired\":false,\"Message\":\"This is a review from api\",\"Mode\":\"review\",\"PrivateFeedback\":\"This is a private feedback from api\"}",
"CreateDate": "2022-01-20T09:10:29.5615997",
"IsIncoming": false,
"ReadDate": "2022-01-20T09:12:06.2171032",
"SenderType": "Host",
"SenderName": "Sample Airbnb Owner RU",
"SenderInitials": "SAOR",
"Attachments": [],
"Sender": {
"ID": 63418,
"FirstName": "Sample Airbnb Owner",
"LastName": "RU"
},
"Receivers": [
{
"ID": 254814,
"FirstName": "",
"LastName": ""
}
]
},
{
"ID": 48574,
"ThreadID": 51558,
"Body": "{\"Creator\":\"guest\","OverallRating":5,\"CategoryRatings\":{\"accuracy\":1,\"value\":5,\"communication\":5,\"location\":5,\"checkin\":5,\"cleanliness\":1},\"CategoryRatingsExtended\":[{\"Category\":\"accuracy\",\"Rating\":1,\"Comment\":\"itIsATestComment\",\"ReviewCategoryTags\":[\"GUEST_REVIEW_HOST_NEGATIVE_UNEXPECTED_NOISE\",\"GUEST_REVIEW_HOST_NEGATIVE_SMALLER_THAN_EXPECTED\",\"GUEST_REVIEW_HOST_NEGATIVE_DID_NOT_MATCH_PHOTOS\",\"ACCURACY_OTHER\",\"GUEST_REVIEW_HOST_NEGATIVE_UNEXPECTED_FEES\",\"GUEST_REVIEW_HOST_NEGATIVE_INACCURATE_LOCATION\",\"GUEST_REVIEW_HOST_NEGATIVE_NEEDS_MAINTENANCE\",\"GUEST_REVIEW_HOST_NEGATIVE_EXCESSIVE_RULES\"]},{\"Category\":\"value\",\"Rating\":5,\"ReviewCategoryTags\":[]},{\"Category\":\"communication\",\"Rating\":5,\"ReviewCategoryTags\":[]},{\"Category\":\"location\",\"Rating\":5,\"Comment\":\"itIsATestComment\",\"ReviewCategoryTags\":[\"LOCATION_OTHER\"]},{\"Category\":\"checkin\",\"Rating\":5,\"Comment\":\"itIsATestComment\",\"ReviewCategoryTags\":[\"GUEST_REVIEW_HOST_POSITIVE_EASY_TO_GET_INSIDE\",\"GUEST_REVIEW_HOST_POSITIVE_FLEXIBLE_CHECK_IN\",\"CHECK_IN_OTHER\",\"GUEST_REVIEW_HOST_POSITIVE_RESPONSIVE_HOST\",\"GUEST_REVIEW_HOST_POSITIVE_EASY_TO_FIND\",\"GUEST_REVIEW_HOST_POSITIVE_FELT_AT_HOME\",\"GUEST_REVIEW_HOST_POSITIVE_CLEAR_INSTRUCTIONS\"]},{\"Category\":\"cleanliness\",\"Rating\":1,\"ReviewCategoryTags\":[\"GUEST_REVIEW_HOST_NEGATIVE_STAINS\",\"GUEST_REVIEW_HOST_NEGATIVE_DIRTY_OR_DUSTY\",\"GUEST_REVIEW_HOST_NEGATIVE_DIRTY_BATHROOM\",\"GUEST_REVIEW_HOST_NEGATIVE_NOTICEABLE_SMELL\",\"GUEST_REVIEW_HOST_NEGATIVE_MESSY_KITCHEN\",\"GUEST_REVIEW_HOST_NEGATIVE_HAIR_OR_PET_HAIR\",\"GUEST_REVIEW_HOST_NEGATIVE_EXCESSIVE_CLUTTER\",\"GUEST_REVIEW_HOST_NEGATIVE_TRASH_LEFT_BEHIND\"]}],\"IsPublished\":true,\"PublishDate\":\"2022-01-20T09:11:52.8013941Z\",\"IsExpired\":false,\"Message\":\"test review from the guest\",\"Mode\":\"review\",\"PrivateFeedback\":\"test private feedback\"}",
"CreateDate": "2022-01-20T09:14:32.846",
"IsIncoming": true,
"ReadDate": "2022-01-20T09:12:06.2171032",
"SenderType": "Guest",
"SenderName": "Traveller",
"SenderInitials": "T",
"Attachments": [],
"Sender": {
"ID": 254814,
"FirstName": "",
"LastName": ""
},
"Receivers": [
{
"ID": 63418,
"FirstName": "Sample Airbnb Owner",
"LastName": "RU"
}
]
},
{
"ID": 48575,
"ThreadID": 51558,
"Body": "{\"Creator\":\"host\",\"IsPublished\":true,\"IsExpired\":false,\"Message\":\"test response\",\"Mode\":\"reply\"}",
"CreateDate": "2022-01-20T09:12:58.3667698",
"IsIncoming": false,
"ReadDate": "2022-01-20T09:12:59.8331378",
"SenderType": "Host",
"SenderName": "Sample Airbnb Owner RU",
"SenderInitials": "SAOR",
"Attachments": [],
"Sender": {
"ID": 63418,
"FirstName": "Sample Airbnb Owner",
"LastName": "RU"
},
"Receivers": [
{
"ID": 254814,
"FirstName": "",
"LastName": ""
}
]
},
{
"ID": 48576,
"ThreadID": 51558,
"Body": "{\"Creator\":\"guest\",\"IsPublished\":true,\"IsExpired\":false,\"Message\":\"response as a guest\",\"Mode\":\"reply\"}",
"CreateDate": "2022-01-20T09:16:35",
"IsIncoming": true,
"ReadDate": "2022-01-21T12:45:19.3152868",
"SenderType": "Guest",
"SenderName": "Traveller",
"SenderInitials": "T",
"Attachments": [],
"Sender": {
"ID": 254814,
"FirstName": "",
"LastName": ""
},
"Receivers": [
{
"ID": 63418,
"FirstName": "Sample Airbnb Owner",
"LastName": "RU"
}
]
}
]
get/api/messaging/threads/{id}/messages
Request
- Base URL: https://api.rentalsunited.com
- URL: https://api.rentalsunited.com/api/messaging/threads/{id}/messages
- Auth: one of:
- API key in header X-RU-AccessKey and API key in header X-RU-SecretKey
- HTTP basic
Path parameters
idinteger required
The ID of the thread
Query parameters
messageLimitinteger required
The number of messages to retrieve
olderThanstring date-time
The date and time of the oldest previously fetched message in UTC, only messages older than this date will be returned
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.