openapi: 3.2.0 info: title: Hostfully Multi-Unit Properties API license: name: Apache 2.0 url: https://www.hostfully.com/ version: v3.0.1 servers: - url: https://sandbox-api.hostfully.com security: - JWT-Authentication: [] - Agency-API-key: [] tags: - name: Multi-Unit Properties paths: /api/v3.3/multi-units/multi-unit-properties: get: tags: - Multi-Unit Properties summary: List multi-unit properties by agency description: Retrieves paginated list of multi-unit properties for a specific agency with optional filtering by update date operationId: findHotelsByAgencyUid parameters: - name: agencyUid in: query required: true schema: type: string - name: _cursor in: query description: Cursor for pagination required: false schema: type: string description: Cursor for pagination - name: _limit in: query description: Limit for pagination required: false schema: type: string description: Limit for pagination - name: updatedSince in: query required: false schema: type: string example: '2024-09-28T10:31:01' example: '2024-09-28T10:31:01' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/HotelApi3_1PaginatedListWrapper' post: tags: - Multi-Unit Properties summary: Create new multi-unit property description: Creates a new multi-unit property record for the specified agency operationId: create_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/HotelCreationRequestApi3_1Dto' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/HotelApi3_1SingleResourceWrapper' /api/v3.3/multi-units/multi-unit-properties/{uid}: get: tags: - Multi-Unit Properties summary: Get multi-unit property by UID description: Retrieves a single multi-unit property by its unique identifier operationId: findByUid_4 parameters: - name: uid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/HotelApi3_1SingleResourceWrapper' delete: tags: - Multi-Unit Properties summary: Delete multi-unit property description: Removes a multi-unit property record from the system operationId: deleteByUid parameters: - name: uid in: path required: true schema: type: string responses: '200': description: OK patch: tags: - Multi-Unit Properties summary: Update multi-unit property description: Partially updates an existing multi-unit property using JSON merge patch semantics operationId: patch_3 parameters: - name: uid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HotelUpdateRequestApi3_1Dto' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/HotelApi3_1SingleResourceWrapper' components: schemas: HotelUpdateRequestApi3_1Dto: type: object properties: name: type: string address: $ref: '#/components/schemas/AddressApi3Dto' mainPhotoUrl: type: string accountingId: type: string rentalLicenseNumber: type: string rentalLicenseNumberExpiryDate: type: string format: date type: type: string enum: - HOTEL - HOSTEL - LODGE - RESORT - LOFT - BOUTIQUE_HOTEL - APARTHOTEL - APARTMENT - VILLA - HOLIDAY_HOME pricing: $ref: '#/components/schemas/HotelPricingSettingApi3_1Dto' HotelCreationRequestApi3_1Dto: type: object properties: name: type: string agencyUid: type: string address: $ref: '#/components/schemas/AddressApi3Dto' mainPhotoUrl: type: string accountingId: type: string rentalLicenseNumber: type: string rentalLicenseNumberExpiryDate: type: string format: date type: type: string enum: - HOTEL - HOSTEL - LODGE - RESORT - LOFT - BOUTIQUE_HOTEL - APARTHOTEL - APARTMENT - VILLA - HOLIDAY_HOME pricing: $ref: '#/components/schemas/HotelPricingSettingApi3_1Dto' AddressApi3Dto: type: object properties: address: type: string address2: type: string city: type: string state: type: string zipCode: type: string countryCode: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AG - AN - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BR - BN - BG - BF - BI - BQ - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - YT - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FJ - FI - FK - FO - FR - GF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GU - GT - GN - GW - GY - GP - HT - VA - HN - HK - HL - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LC - LS - LR - LY - LI - LT - LU - MO - MQ - MK - MG - MW - MY - MV - ML - MT - MH - MR - MU - MX - FM - MD - MC - MN - MS - MA - MZ - MM - ME - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - 'NO' - OM - PK - PW - PA - PG - PS - PY - PE - PF - PH - PL - PN - PT - PR - QA - RO - RU - RW - KN - WS - RE - PM - SH - ST - SM - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - ES - LK - SR - SJ - SZ - SE - CH - SY - TC - TW - TJ - TZ - TH - TG - TO - TT - TN - TR - TM - TV - UG - UA - AE - GB - JE - IM - US - UY - UZ - VC - VU - VE - VN - VG - VI - WF - EH - YE - YU - ZM - ZW longitude: type: number format: double latitude: type: number format: double Api3ResponseMetadata: type: object properties: count: type: integer format: int32 totalCount: type: integer format: int32 HotelPricingSettingApi3_1Dto: type: object properties: currency: type: string enum: - AED - ARS - AUD - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CZK - DKK - DOP - EUR - GBP - GTQ - HKD - HUF - IDR - IKR - ILS - INR - JPY - KES - KRW - MXN - MYR - NOK - NONE - NZD - PEN - PHP - PLN - RON - RUB - SEK - SGD - THB - TRY - TWD - USD - UYU - VEF - VND - VUV - JOD - SAR - EGP - ZAR - TTD - BBD - CVE - AWG - MAD - PYG HotelApi3_1Dto: type: object properties: uid: type: string agencyUid: type: string name: type: string createdDateTime: type: string format: date-time pricing: $ref: '#/components/schemas/HotelPricingSettingApi3_1Dto' address: $ref: '#/components/schemas/AddressApi3Dto' mainPhotoUrl: type: string accountingId: type: string rentalLicenseNumber: type: string rentalLicenseNumberExpiryDate: type: string format: date type: type: string enum: - HOTEL - HOSTEL - LODGE - RESORT - LOFT - BOUTIQUE_HOTEL - APARTHOTEL - APARTMENT - VILLA - HOLIDAY_HOME HotelApi3_1PaginatedListWrapper: type: object properties: hotels: type: array items: $ref: '#/components/schemas/HotelApi3_1Dto' _metadata: $ref: '#/components/schemas/Api3ResponseMetadata' _paging: $ref: '#/components/schemas/Api3ResponsePaging' Api3ResponsePaging: type: object properties: _limit: type: integer format: int32 _nextCursor: type: string HotelApi3_1SingleResourceWrapper: type: object properties: hotel: $ref: '#/components/schemas/HotelApi3_1Dto' securitySchemes: JWT-Authentication: type: apiKey description: OAuth Access Token name: Authorization in: header Agency-API-key: type: apiKey description: API Key name: X-HOSTFULLY-APIKEY in: header externalDocs: description: Hostfully Documentation url: https://dev.hostfully.com/v3.0/reference x-readme: explorer-enabled: true proxy-enabled: true