openapi: 3.2.0
info:
  title: Hostfully Guests 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: Guests
paths:
  /api/v3.3/guests/{agencyUid}:
    get:
      tags:
      - Guests
      summary: Get all guests
      description: Retrieve all guests associated with the specified agency UID.
      operationId: getAll_10
      parameters:
      - name: agencyUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GuestsApi3ResponseWrapper'
components:
  schemas:
    GuestsApi3ResponseDto:
      type: object
      properties:
        lastName:
          type: string
        zipCode:
          type: string
        linkedinURL:
          type: string
        city:
          type: string
        mobileNumber:
          type: string
        pictureURL:
          type: string
        address:
          type: string
        address2:
          type: string
        birthDate:
          type: string
          format: date
        favoriteAirline:
          type: string
        firstName:
          type: string
        skypeID:
          type: string
        facebookURL:
          type: string
        phoneNumber:
          type: string
        profileNotes:
          type: string
        state:
          type: string
        email:
          type: string
        uid:
          type: string
        created:
          type: string
          example: '2026-04-20T11:52:36'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    GuestsApi3ResponseWrapper:
      type: object
      properties:
        guests:
          type: array
          items:
            $ref: '#/components/schemas/GuestsApi3ResponseDto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
  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