Inbox Conversations

Get conversation by id

get/communication/conversations/{conversationId}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/communication/conversations/{conversationId}
  • Auth
    API key in header authorization

Path parameters

conversationIdstring required

Saved Conversation Id

Query parameters

fieldsstring

Selection of fields, separated by space.

When null retrieve the main properties of the object.

We recommend always specifying the specific fields you'd like to receive to ensure that you get them. Please see the full list above.

Response

OK

statusnumber

Example response

{
  "status": 200,
  "data": {
    "_id": "6134a49cd450d300307794cb",
    "priority": 10,
    "meta": {
      "reservations": [
        {
          "_id": "61347d71d450d300307792a4",
          "status": "inquiry",
          "checkIn": "2021-09-04T21:00:00.000Z",
          "checkOut": "2021-09-05T20:00:00.000Z",
          "listing": {
            "tags": [
              "Pool"
            ],
            "_id": "5fba2d97d8e638002d76d842",
            "picture": {
              "_id": "615c0214cdf3370028883d3a",
              "thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1606036872/preprod/5fb67280e39677002e6c2683/ephepadfvgopafgykxrc.jpg"
            },
            "address": {
              "full": "Loma Mazamitla Sur, La Aurora, 44790 Guadalajara, Jal., Mexico",
              "city": "Guadalajara",
              "country": "Mexico",
              "state": "Jalisco"
            },
            "nickname": "OPS-Listing",
            "title": "TEST"
          }
        }
      ],
      "guest": {
        "_id": "61347d70d450d300307792a3",
        "email": "asdasd@assadsa.com"
      }
    },
    "accountId": "5fb67280e39677002e6c2683",
    "createdAt": "2021-09-05T11:06:05.388Z",
    "state": {
      "status": "OPEN"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.