openapi: 3.2.0
info:
  title: Hostfully Custom Data Fields 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: Custom Data Fields
paths:
  /api/v3.3/custom-data-fields:
    get:
      tags:
      - Custom Data Fields
      summary: Get all agency custom data fields
      description: Retrieve all custom data fields associated with the specified agency.
      operationId: getAll_16
      parameters:
      - name: agencyUid
        in: query
        required: true
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
          enum:
          - SORT_BY_NAME
          - SORT_BY_TYPE
          - SORT_BY_VARIABLE
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          default: ASC
          enum:
          - ASC
          - DESC
      - name: usage
        in: query
        required: false
        schema:
          type: string
          enum:
          - CUSTOM_VARIABLES
          - PRE_ARRIVAL_FORM
          - OTHER
      - 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
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomDataV32ResponseWrapper'
    post:
      tags:
      - Custom Data Fields
      summary: Create a custom data field
      description: Create a new custom data field for the given agency using the provided data.
      operationId: post_13
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDataFieldAddingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomDataFieldApiResponseWrapper'
  /api/v3.3/custom-data-fields/{customDataFieldUid}:
    get:
      tags:
      - Custom Data Fields
      summary: Get a custom data field
      description: Fetch details of a single custom data field identified by its UID.
      operationId: getOne_10
      parameters:
      - name: customDataFieldUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomDataFieldApiResponseWrapper'
    delete:
      tags:
      - Custom Data Fields
      summary: Delete a custom data field
      description: Remove the custom data field identified by the given UID.
      operationId: delete_12
      parameters:
      - name: customDataFieldUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
components:
  schemas:
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    CustomDataFieldApi3Dto:
      type: object
      properties:
        agencyUid:
          type: string
        uid:
          type: string
        type:
          type: string
          enum:
          - TEXT
          - LONG_TEXT
          - SINGLE_SELECT
        name:
          type: string
        variable:
          type: string
        index:
          type: integer
          format: int32
        minAgeToShow:
          type: integer
          format: int32
        subType:
          type: string
          enum:
          - PRIMARY_GUEST_INFORMATION
          - OTHER_GUEST_INFORMATION
          - ADDITIONAL_GUEST_INFORMATION
          - ARRIVAL_INFORMATION
          - OTHER
        usage:
          type: string
          enum:
          - CUSTOM_VARIABLES
          - PRE_ARRIVAL_FORM
          - OTHER
        isOptional:
          type: boolean
        isActive:
          type: boolean
        options:
          type: array
          items:
            $ref: '#/components/schemas/CustomDataFieldOptionDto'
    CustomDataFieldApiResponseWrapper:
      type: object
      properties:
        customDataField:
          $ref: '#/components/schemas/CustomDataFieldApi3Dto'
    CustomDataFieldAddingApi3Dto:
      required:
      - agencyUid
      - name
      - type
      type: object
      properties:
        agencyUid:
          type: string
        type:
          type: string
          enum:
          - TEXT
          - LONG_TEXT
          - SINGLE_SELECT
        name:
          maxLength: 255
          minLength: 0
          type: string
        variable:
          type: string
        index:
          type: integer
          format: int32
        minAgeToShow:
          type: integer
          format: int32
        subType:
          type: string
          enum:
          - PRIMARY_GUEST_INFORMATION
          - OTHER_GUEST_INFORMATION
          - ADDITIONAL_GUEST_INFORMATION
          - ARRIVAL_INFORMATION
          - OTHER
        usage:
          type: string
          enum:
          - CUSTOM_VARIABLES
          - PRE_ARRIVAL_FORM
          - OTHER
    CustomDataFieldOptionDto:
      type: object
      properties:
        uid:
          type: string
        optionText:
          type: string
        optionValue:
          type: string
        sortOrder:
          type: integer
          format: int32
        active:
          type: boolean
    CustomDataV32ResponseWrapper:
      type: object
      properties:
        customDataFields:
          type: array
          items:
            $ref: '#/components/schemas/CustomDataFieldApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
        _paging:
          $ref: '#/components/schemas/Api3ResponsePaging'
    Api3ResponsePaging:
      type: object
      properties:
        _limit:
          type: integer
          format: int32
        _nextCursor:
          type: string
  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