openapi: 3.2.0
info:
  title: Hostfully Agencies 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: Agencies
paths:
  /api/v3.3/agencies/{uid}:
    get:
      tags:
      - Agencies
      summary: Get an agency by UID
      description: Returns the agency details for the given UID, only if the API client is authorized to access it.
      operationId: getAgency
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgencyApiV3ResponseWrapper'
  /api/v3.3/agencies:
    get:
      tags:
      - Agencies
      summary: Get agencies
      description: Returns the list of agencies the API client is authorized to access.
      operationId: getAgencies
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgenciesApiV3ResponseWrapper'
components:
  schemas:
    AgenciesApiV3ResponseWrapper:
      type: object
      properties:
        agencies:
          type: array
          items:
            $ref: '#/components/schemas/AgencyApi3ResponseDto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    AgencyApi3ResponseDto:
      type: object
      properties:
        uid:
          type: string
        name:
          type: string
        agencyEmailAddress:
          type: string
        phoneNumber:
          type: string
        website:
          type: string
        address1:
          type: string
        city:
          type: string
        zipCode:
          type: string
        state:
          type: string
        currency:
          type: string
        currencyCode:
          type: string
          enum:
          - USD
          - EUR
          - GBP
          - CAD
          - JPY
          - INR
          - MYR
          - AUD
          - KES
          - MXN
          - HKD
          - NZD
          - CHF
          - BRL
          - CLP
          - COP
          - PEN
          - ARS
          - UYU
          - VEF
          - CNY
          - THB
          - KRW
          - IDR
          - SGD
          - TWD
          - AED
          - ZAR
          - CZK
          - DKK
          - DOP
          - SEK
          - BGN
          - ILS
          - NOK
          - RON
          - RUB
          - PHP
          - VND
          - HUF
          - IKR
          - PLN
          - PYG
          - TRY
          - GTQ
          - VUV
          - JOD
          - SAR
          - EGP
          - TTD
          - MAD
          - CVE
          - BBD
          - AWG
          - BHD
          - NONE
        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
        defaultCheckInTime:
          type: integer
          format: int32
        defaultCheckOutTime:
          type: integer
          format: int32
        rentalCondition:
          type: string
        agencyConfirmed:
          type: boolean
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    AgencyApiV3ResponseWrapper:
      type: object
      properties:
        agency:
          $ref: '#/components/schemas/AgencyApi3ResponseDto'
  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