openapi: 3.2.0
info:
  title: Hostfully Pin Codes 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: Pin Codes
paths:
  /api/v3.3/pin-codes/{pinCodeUid}:
    put:
      tags:
      - Pin Codes
      summary: Update pin code
      description: Modifies an existing pin code's details (code value or URL ...)
      operationId: put_10
      parameters:
      - name: pinCodeUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinCodeAddingApi3_1Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PinCodeApi3ResponseWrapperPinCodeApi3_1Dto'
    delete:
      tags:
      - Pin Codes
      summary: Delete pin code
      description: Revokes and removes a pin code.
      operationId: delete_13
      parameters:
      - name: pinCodeUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /api/v3.3/pin-codes:
    get:
      tags:
      - Pin Codes
      summary: List pin codes
      description: Retrieves pin codes for a property or lead. Either propertyUid or leadUid parameter is required
      operationId: getAll_17
      parameters:
      - name: propertyUid
        in: query
        required: false
        schema:
          type: string
      - name: leadUid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PinCodesApi3ResponseWrapperPinCodeApi3_1Dto'
    post:
      tags:
      - Pin Codes
      summary: Create pin code
      description: Generates a new pin code for property access.
      operationId: post_14
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinCodeAddingApi3_1Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PinCodeApi3ResponseWrapperPinCodeApi3_1Dto'
components:
  schemas:
    PinCodesApi3ResponseWrapperPinCodeApi3_1Dto:
      type: object
      properties:
        pincodes:
          type: array
          items:
            $ref: '#/components/schemas/PinCodeApi3_1Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    PinCodeApi3_1Dto:
      type: object
      properties:
        uid:
          type: string
        propertyUid:
          type: string
        lockType:
          type: string
          enum:
          - RESORTLOCK
          - REMOTELOCK
          - PARAKEET
          - AUGUST
          - OTHER
          - VIRTUALKEY
          - OPERTO
          - DORMAKABA
          - POINTCENTRAL
        startDateTimeUTC:
          type: string
          example: '2026-04-20T11:52:36'
        endDateTimeUTC:
          type: string
          example: '2026-04-20T11:52:36'
        pinCode:
          type: string
        pinCodeUrl:
          type: string
        leadUid:
          type: string
        unitUid:
          type: string
          description: Uid of a specific unit. Will only be non null for multi-unit inventory, meaning if 'propertyUid' is a uid of a unit type.
    PinCodeAddingApi3_1Dto:
      type: object
      properties:
        propertyUid:
          type: string
        lockType:
          type: string
          enum:
          - RESORTLOCK
          - REMOTELOCK
          - PARAKEET
          - AUGUST
          - OTHER
          - VIRTUALKEY
          - OPERTO
          - DORMAKABA
          - POINTCENTRAL
        startDateTimeUTC:
          type: string
          example: '2026-04-20T11:52:36'
        endDateTimeUTC:
          type: string
          example: '2026-04-20T11:52:36'
        pinCode:
          type: string
        pinCodeUrl:
          type: string
        leadUid:
          type: string
        unitUid:
          type: string
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PinCodeApi3ResponseWrapperPinCodeApi3_1Dto:
      type: object
      properties:
        pinCode:
          $ref: '#/components/schemas/PinCodeApi3_1Dto'
  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