GUguesty
Integrations

Get an integration

Changed on

Retrieve a single account integration.

get/integrations/{id}

Request

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

Path parameters

idstring required

Integration 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

User Integration

_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

  • 3122b8618183Revision changes
    • breaking

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

    • info

      api operation id accountsIntegrationGet was added