openapi: 3.2.0 info: title: Hostfully Owners 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: Owners paths: /api/v3.3/owners/{ownerUid}: get: tags: - Owners summary: Get owner details description: Retrieves detailed information about a specific owner by their UID operationId: getOne_6 parameters: - name: ownerUid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OwnerApiResponseWrapper' delete: tags: - Owners summary: Remove owner from agency description: Remove owner from agency. operationId: delete_8 parameters: - name: ownerUid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: object patch: tags: - Owners summary: Update owner information description: Partially updates owner details using JSON merge patch semantics operationId: patch_2 parameters: - name: ownerUid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OwnerUpdatingApi3Dto' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OwnerApiResponseWrapper' /api/v3.3/owners: get: tags: - Owners summary: List owners by agency description: Retrieves all owners for a specific agency with optional search query filtering operationId: getAll_8 parameters: - name: agencyUid in: query required: true schema: type: string - name: query in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OwnersApiResponseWrapper' components: schemas: Api3ResponseMetadata: type: object properties: count: type: integer format: int32 totalCount: type: integer format: int32 OwnersApiResponseWrapper: type: object properties: owners: type: array items: $ref: '#/components/schemas/OwnerApi3Dto' _metadata: $ref: '#/components/schemas/Api3ResponseMetadata' OwnerApi3Dto: type: object properties: uid: type: string email: type: string firstName: type: string lastName: type: string isActive: type: boolean phoneNumberAreaCode: type: integer format: int32 phoneNumber: type: string businessName: type: string website: type: string pictureUrl: type: string country: 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 preferredLocale: type: string enum: - en_US - fr_FR - es_ES - it_IT - de_DE - nl_NL - pt_PT - no_NO - pl_PL externalCalendarUrl: type: string ccEmails: type: string airbnbUserId: type: string permissionTypes: uniqueItems: true type: array items: type: string enum: - READING_CALENDAR - READING_BOOKING_DETAILS - READING_BOOKING_VALUE - CREATING_BLOCKS - VIEW_ANALYTICS agencyCommissionRate: type: number OwnerUpdatingApi3Dto: type: object properties: firstName: type: string lastName: type: string phoneNumberAreaCode: type: integer format: int32 phoneNumber: type: string businessName: type: string website: type: string pictureUrl: type: string country: 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 preferredLocale: type: string enum: - en_US - fr_FR - es_ES - it_IT - de_DE - nl_NL - pt_PT - no_NO - pl_PL externalCalendarUrl: type: string ccEmails: type: string airbnbUserId: type: string permissionTypes: uniqueItems: true type: array items: type: string enum: - READING_CALENDAR - READING_BOOKING_DETAILS - READING_BOOKING_VALUE - CREATING_BLOCKS - VIEW_ANALYTICS agencyCommissionRate: type: number OwnerApiResponseWrapper: type: object properties: owner: $ref: '#/components/schemas/OwnerApi3Dto' 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