openapi: 3.2.0
info:
  title: Hostfully Threads 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: Threads
paths:
  /api/v3.3/threads/{threadUid}:
    get:
      tags:
      - Threads
      summary: Get thread details
      description: Retrieves a specific messaging thread by its unique identifier
      operationId: findThreadByUid
      parameters:
      - name: threadUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ThreadApiWrapper'
  /api/v3.3/threads:
    get:
      tags:
      - Threads
      summary: List threads
      description: 'Retrieve threads with optional filters for agencyUid and leadUid,

        as well as pagination parameters (_limit, _cursor).

        Note: Either agencyUid or leadUid must be provided.'
      operationId: findThreads
      parameters:
      - name: agencyUid
        in: query
        required: false
        schema:
          type: string
      - name: leadUid
        in: query
        required: false
        schema:
          type: string
      - name: _limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: _cursor
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ThreadApiListWrapper'
components:
  schemas:
    ThreadApiWrapper:
      type: object
      properties:
        thread:
          $ref: '#/components/schemas/ThreadApi3_2Dto'
    ThreadApiListWrapper:
      type: object
      properties:
        threads:
          type: array
          items:
            $ref: '#/components/schemas/ThreadApi3_2Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
        _paging:
          $ref: '#/components/schemas/Api3ResponsePaging'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    ThreadApi3_2Dto:
      type: object
      properties:
        uid:
          type: string
        creationDate:
          type: string
          format: date-time
        lastUpdateDate:
          type: string
          format: date-time
        participants:
          type: array
          items:
            $ref: '#/components/schemas/ThreadApi3_2ParticipantDto'
        participantsReadStatuses:
          type: array
          items:
            $ref: '#/components/schemas/ThreadApi3_2ParticipantReadStatusDto'
    ThreadApi3_2ParticipantDto:
      type: object
      properties:
        participantType:
          type: string
          enum:
          - PMP
          - AGENCY
          - PM_EMPLOYEE
          - AGENT
          - GUEST
          - OWNER
          - SERVICE_PROVIDER
          - LEAD
        participantUid:
          type: string
        uid:
          type: string
    Api3ResponsePaging:
      type: object
      properties:
        _limit:
          type: integer
          format: int32
        _nextCursor:
          type: string
    ThreadApi3_2ParticipantReadStatusDto:
      type: object
      properties:
        participantUid:
          type: string
        lastRead:
          type: string
          format: date-time
        readStatus:
          type: string
          enum:
          - READ
          - UNREAD
  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