openapi: 3.2.0
info:
  title: Hostfully Extra 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: Extra Guests
paths:
  /api/v3.3/extra-guests/{leadUid}:
    get:
      tags:
      - Extra Guests
      summary: Fetch extra guests by lead
      description: Retrieve the list of extra guests associated with the specified lead UID.
      operationId: fetchExtraGuestsByLead
      parameters:
      - name: leadUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ExtraGuestsApiV3ResponseWrapper'
components:
  schemas:
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    ExtraGuestsApi3ResponseDto:
      type: object
      properties:
        leadUid:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        age:
          type: integer
          format: int32
    ExtraGuestsApiV3ResponseWrapper:
      type: object
      properties:
        extraGuests:
          type: array
          items:
            $ref: '#/components/schemas/ExtraGuestsApi3ResponseDto'
        _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