GUguesty
Accounts

Get account details

Changed on

Retrieve the account details associated with the token making the request, including its settings and custom field values. The fields returned depend on the caller's permissions — restricted areas of the account, and custom fields marked private, are omitted rather than causing an error.

get/accounts/me

Request

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

Response

Retrieved account details.

idstring
activeboolean

Status of connection

namestring
emailstring email
timezonestring
mailgunobject
isInterestedInServiceOnExistingReservationsboolean
siqnupQuestionsobject
ignoredHooksstring[]
initialLocationstring
recognizedRevenueDaysnumber
sisenseAccessboolean
recognizedRevenueMode'check-in' | 'check-out' | 'per_night'
createdAtstring date
RUFeeActivationboolean
currencystring
companyLogostring
accountCategorizationnumber
accountCategorizationIsManualboolean
agodaEmailstring email
pricePlanMinimumnumber
pricePlanMaximumnumber
SaaSobject
weekendBasePriceMigrationDoneboolean
hadFirstBookingAtstring date
availablePhoneNumbersstring[]

Phone numbers purchased on this account.

commissionFormulastring
netIncomeFormulastring
ownerRevenueFormulastring
commissionTaxPercentagenumber
systemEmailsRecipientsstring[]

Example response

{
  "ignoredHooks": [
    "5981b4b8c97c260f0067c499"
  ]
}

Changes

  • 3122b8618183Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • warning

      added the new dayofweek enum value to the // response property for the response status

    • info

      api operation id accountsGet was added

    • info

      added the optional property // to the response with the status