Integrations

Create an integration

Changed on

Deprecated: Was used for building an integration between Guesty and a third-party.

post/integrations

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/integrations
  • Auth
    API key in header authorization

Request body

platformstring required

Integration name

Example request

{
  "platform": "manual"
}

Response

The created integration object.

_idstring

Unique Id

activeboolean

Status of connection

platformstring
listingsobject[]
complexesobject[]
nicknamestring
channelIdstring
activatedAtstring

Date

disconnectedAtstring

Date

proxyEmailstring
incomingEmailstring
externalAccountIdstring
idstring

External ID

companyNamestring
status'NOT_CONNECTED' | 'CONNECTING' | 'CONNECTED' | 'FAILED' | 'TIMEOUT' | 'DISCONNECTED' | 'PENDING'
userIdstring
accountIdstring

Owner

tripAdvisorobject

TripAdvisor details

homeaway2object

Homeaway details

createdAtstring

Date

missingStepstring
newIntegrationBackupobject
threadIdsMigratedboolean
isDeletedboolean
deletedAtstring

Date

Example response

{
  "_id": "5958c7e5884e961000817799",
  "airbnb2": {
    "ignored": {
      "reservations": [],
      "listings": []
    },
    "emailsFromSupport": []
  },
  "nickname": "naama",
  "id": "naama@user.guesty.com",
  "userId": "563e0b6a08a2710e00057b85",
  "accountId": "563e0b6a08a2710e00057b82"
}

Changes

    • breaking

      the response's property type changed from integer to string for status

    • info

      api operation id accountsIntegrationCreate was added