> ## Documentation Index
> Fetch the complete documentation index at: https://docs-v2.sortx.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Enquiry

> Read one enquiry with its transcript, answers and escalations



## OpenAPI

````yaml /openapi.json get /front-desk/enquiries/{id}
openapi: 3.1.0
info:
  title: SortX API
  version: 1.0.0
  description: >-
    Reactive repairs, planned maintenance, compliance and the repairs desk for
    UK letting agents and property managers.
servers:
  - url: https://api.sortx.co.uk
    description: Production
security: []
tags:
  - name: tenants
  - name: entitlements
  - name: events
  - name: workspace-settings
  - name: operational-catalogues
  - name: money
  - name: contacts
  - name: properties
  - name: address-lookup
  - name: tenancies
  - name: contractor-invoices
  - name: keys
  - name: inspections
  - name: handovers
  - name: planned-maintenance
  - name: contractors
  - name: documents
  - name: compliance
  - name: activity
  - name: tasks
  - name: today
  - name: reports
  - name: workspace-search
  - name: calendar
  - name: telephony
  - name: maintenance-pro
  - name: front-desk
  - name: maintenance-pro-public
  - name: maintenance-pro-contractor
paths:
  /front-desk/enquiries/{id}:
    get:
      tags:
        - front-desk
      summary: Enquiry
      description: Read one enquiry with its transcript, answers and escalations
      operationId: front-desk.enquiry
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  enquiry:
                    type: object
                    properties:
                      id:
                        type: string
                      callId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      channel:
                        type: string
                      updatedAt:
                        type: string
                      whatsappThreadId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      smsThreadId:
                        anyOf:
                          - anyOf:
                              - type: string
                              - type: 'null'
                          - type: 'null'
                      contactId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      state:
                        type: string
                      intent:
                        anyOf:
                          - type: string
                          - type: 'null'
                      outcome:
                        anyOf:
                          - type: string
                          - type: 'null'
                      summary:
                        anyOf:
                          - type: string
                          - type: 'null'
                      callerNumber:
                        type: string
                      startedAt:
                        type: string
                      endedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      durationSeconds:
                        anyOf:
                          - anyOf:
                              - type: number
                              - type: string
                                enum:
                                  - Infinity
                                  - '-Infinity'
                                  - NaN
                          - type: 'null'
                      providerConversationId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      teamId:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - id
                      - callId
                      - channel
                      - updatedAt
                      - whatsappThreadId
                      - contactId
                      - state
                      - intent
                      - outcome
                      - summary
                      - callerNumber
                      - startedAt
                      - endedAt
                      - durationSeconds
                      - providerConversationId
                      - teamId
                    additionalProperties: false
                  whatsapp:
                    anyOf:
                      - type: object
                        properties:
                          threadId:
                            type: string
                          connectionId:
                            type: string
                          consent:
                            type: string
                          matchState:
                            type: string
                          windowExpiresAt:
                            anyOf:
                              - type: string
                              - type: 'null'
                          enabled:
                            type: boolean
                          displayName:
                            type: string
                          messages:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                clientId:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                direction:
                                  type: string
                                type:
                                  type: string
                                text:
                                  type: string
                                status:
                                  type: string
                                error:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                at:
                                  type: string
                                mediaId:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                filename:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                mediaStored:
                                  type: boolean
                                mediaError:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                              required:
                                - id
                                - clientId
                                - direction
                                - type
                                - text
                                - status
                                - error
                                - at
                                - mediaId
                                - filename
                                - mediaStored
                                - mediaError
                              additionalProperties: false
                          templates:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                language:
                                  type: string
                                category:
                                  type: string
                                status:
                                  type: string
                                qualityRating:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                rejectionReason:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                body:
                                  type: string
                                parameterCount:
                                  anyOf:
                                    - type: number
                                    - type: string
                                      enum:
                                        - Infinity
                                        - '-Infinity'
                                        - NaN
                                supported:
                                  type: boolean
                                unsupportedReason:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                lastSyncedAt:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                              required:
                                - id
                                - name
                                - language
                                - category
                                - status
                                - qualityRating
                                - rejectionReason
                                - body
                                - parameterCount
                                - supported
                                - unsupportedReason
                                - lastSyncedAt
                              additionalProperties: false
                        required:
                          - threadId
                          - connectionId
                          - consent
                          - matchState
                          - windowExpiresAt
                          - enabled
                          - displayName
                          - messages
                          - templates
                        additionalProperties: false
                      - type: 'null'
                  transcript:
                    type: array
                    items:
                      type: object
                      properties:
                        sequence:
                          anyOf:
                            - type: number
                            - type: string
                              enum:
                                - Infinity
                                - '-Infinity'
                                - NaN
                        role:
                          type: string
                        text:
                          type: string
                        at:
                          type: string
                      required:
                        - sequence
                        - role
                        - text
                        - at
                      additionalProperties: false
                  answers:
                    type: array
                    items:
                      type: object
                      properties:
                        questionKey:
                          type: string
                        answer:
                          type: string
                      required:
                        - questionKey
                        - answer
                      additionalProperties: false
                  escalations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        reason:
                          type: string
                        smsOutboxId:
                          anyOf:
                            - anyOf:
                                - type: number
                                - type: string
                                  enum:
                                    - Infinity
                                    - '-Infinity'
                                    - NaN
                            - type: 'null'
                        taskId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        createdAt:
                          type: string
                      required:
                        - id
                        - reason
                        - smsOutboxId
                        - taskId
                        - createdAt
                      additionalProperties: false
                  outcomes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        enquiryId:
                          type: string
                        kind:
                          type: string
                        state:
                          type: string
                        payload:
                          type: object
                        contactId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        propertyId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        summary:
                          anyOf:
                            - type: string
                            - type: 'null'
                        acknowledgedByUserId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        acknowledgedAt:
                          anyOf:
                            - type: string
                            - type: 'null'
                        note:
                          anyOf:
                            - type: string
                            - type: 'null'
                        linkedKind:
                          anyOf:
                            - type: string
                            - type: 'null'
                        linkedId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        createdAt:
                          type: string
                      required:
                        - id
                        - enquiryId
                        - kind
                        - state
                        - payload
                        - contactId
                        - propertyId
                        - summary
                        - acknowledgedByUserId
                        - acknowledgedAt
                        - note
                        - linkedKind
                        - linkedId
                        - createdAt
                      additionalProperties: false
                  outcomeChecks:
                    anyOf:
                      - type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            status:
                              type: string
                              enum:
                                - verified
                                - review_needed
                            reasons:
                              type: array
                              items:
                                type: object
                                properties:
                                  code:
                                    type: string
                                  detail:
                                    type: string
                                required:
                                  - code
                                  - detail
                                additionalProperties: false
                            assessmentIds:
                              type: array
                              items:
                                type: string
                            model:
                              anyOf:
                                - type: string
                                - type: 'null'
                            taskId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            createdAt:
                              type: string
                          required:
                            - id
                            - status
                            - reasons
                            - assessmentIds
                            - model
                            - taskId
                            - createdAt
                          additionalProperties: false
                      - type: 'null'
                required:
                  - enquiry
                  - whatsapp
                  - transcript
                  - answers
                  - escalations
                  - outcomes
                additionalProperties: false
        '400':
          description: >-
            TenantCreateRejected | ConfigMissing | IntegrationRejected |
            AuthRejected | RegistrationRejected | UnknownIntegration |
            WebhookUnroutable | RateUnavailable
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/TenantCreateRejectedEncoded'
                  - $ref: '#/components/schemas/ConfigMissingEncoded'
                  - $ref: '#/components/schemas/IntegrationRejectedEncoded'
                  - $ref: '#/components/schemas/AuthRejectedEncoded'
                  - $ref: '#/components/schemas/RegistrationRejectedEncoded'
                  - $ref: '#/components/schemas/UnknownIntegrationEncoded'
                  - $ref: '#/components/schemas/WebhookUnroutableEncoded'
                  - $ref: '#/components/schemas/RateUnavailableEncoded'
        '401':
          description: Unauthenticated | WebhookRejected | ApiKeyRejected
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/UnauthenticatedEncoded'
                  - $ref: '#/components/schemas/WebhookRejectedEncoded'
                  - $ref: '#/components/schemas/ApiKeyRejectedEncoded'
        '402':
          description: TenantSuspended
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSuspendedEncoded'
        '403':
          description: >-
            EntitlementMissing | NotAMember | ScopeUnknown | ScopeMissing |
            TenantMismatch | WorkspaceOwnerRequired | WorkspaceRoleRequired
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/EntitlementMissingEncoded'
                  - $ref: '#/components/schemas/NotAMemberEncoded'
                  - $ref: '#/components/schemas/ScopeUnknownEncoded'
                  - $ref: '#/components/schemas/ScopeMissingEncoded'
                  - $ref: '#/components/schemas/TenantMismatchEncoded'
                  - $ref: '#/components/schemas/WorkspaceOwnerRequiredEncoded'
                  - $ref: '#/components/schemas/WorkspaceRoleRequiredEncoded'
        '404':
          description: TenantNotFound | ModuleRequestNotFound
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/TenantNotFoundEncoded'
                  - $ref: '#/components/schemas/ModuleRequestNotFoundEncoded'
                  - $ref: '#/components/schemas/EnquiryNotFoundError'
        '409':
          description: WebhookDuplicate | RegistrationConflict | MoneyBusy
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/WebhookDuplicateEncoded'
                  - $ref: '#/components/schemas/RegistrationConflictEncoded'
                  - $ref: '#/components/schemas/MoneyBusyEncoded'
        '429':
          description: RateLimited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedEncoded'
        '503':
          description: IntegrationUnavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationUnavailableEncoded'
      security:
        - apiKey: []
components:
  schemas:
    TenantCreateRejectedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - TenantCreateRejected
        reason:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - _tag
        - reason
      additionalProperties: false
    ConfigMissingEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - ConfigMissing
        key:
          type: string
      required:
        - _tag
        - key
      additionalProperties: false
    IntegrationRejectedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - IntegrationRejected
        integration:
          type: string
        reason:
          type: string
      required:
        - _tag
        - integration
        - reason
      additionalProperties: false
    AuthRejectedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - AuthRejected
        code:
          type: string
        message:
          type: string
      required:
        - _tag
        - code
        - message
      additionalProperties: false
    RegistrationRejectedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - RegistrationRejected
        message:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - _tag
        - message
      additionalProperties: false
    UnknownIntegrationEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - UnknownIntegration
        integration:
          type: string
      required:
        - _tag
        - integration
      additionalProperties: false
    WebhookUnroutableEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - WebhookUnroutable
        integration:
          type: string
        reason:
          type: string
      required:
        - _tag
        - integration
        - reason
      additionalProperties: false
    RateUnavailableEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - RateUnavailable
        base:
          type: string
        quote:
          type: string
        'on':
          type: string
      required:
        - _tag
        - base
        - quote
        - 'on'
      additionalProperties: false
    UnauthenticatedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - Unauthenticated
      required:
        - _tag
      additionalProperties: false
    WebhookRejectedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - WebhookRejected
        integration:
          type: string
        reason:
          type: string
      required:
        - _tag
        - integration
        - reason
      additionalProperties: false
    ApiKeyRejectedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - ApiKeyRejected
      required:
        - _tag
      additionalProperties: false
    TenantSuspendedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - TenantSuspended
        tenantId:
          type: string
        reason:
          type: string
      required:
        - _tag
        - tenantId
        - reason
      additionalProperties: false
    EntitlementMissingEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - EntitlementMissing
        tenantId:
          type: string
        moduleId:
          type: string
      required:
        - _tag
        - tenantId
        - moduleId
      additionalProperties: false
    NotAMemberEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - NotAMember
        userId:
          type: string
        slug:
          type: string
      required:
        - _tag
        - userId
        - slug
      additionalProperties: false
    ScopeUnknownEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - ScopeUnknown
        scope:
          type: string
      required:
        - _tag
        - scope
      additionalProperties: false
    ScopeMissingEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - ScopeMissing
        scope:
          type: string
      required:
        - _tag
        - scope
      additionalProperties: false
    TenantMismatchEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - TenantMismatch
        header:
          type: string
        organizationId:
          type: string
      required:
        - _tag
        - header
        - organizationId
      additionalProperties: false
    WorkspaceOwnerRequiredEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - WorkspaceOwnerRequired
      required:
        - _tag
      additionalProperties: false
    WorkspaceRoleRequiredEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - WorkspaceRoleRequired
        role:
          anyOf:
            - type: string
            - type: 'null'
        required:
          type: array
          items:
            type: string
        message:
          type: string
      required:
        - _tag
        - role
        - required
        - message
      additionalProperties: false
    TenantNotFoundEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - TenantNotFound
        slug:
          type: string
      required:
        - _tag
        - slug
      additionalProperties: false
    ModuleRequestNotFoundEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - ModuleRequestNotFound
        id:
          type: string
      required:
        - _tag
        - id
      additionalProperties: false
    EnquiryNotFoundError:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - EnquiryNotFound
        id:
          type: string
      required:
        - _tag
        - id
      additionalProperties: false
    WebhookDuplicateEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - WebhookDuplicate
        integration:
          type: string
        externalId:
          type: string
      required:
        - _tag
        - integration
        - externalId
      additionalProperties: false
    RegistrationConflictEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - RegistrationConflict
        message:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - _tag
        - message
      additionalProperties: false
    MoneyBusyEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - MoneyBusy
        message:
          type: string
      required:
        - _tag
        - message
      additionalProperties: false
    RateLimitedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - RateLimited
        key:
          type: string
        retryAfterSeconds:
          anyOf:
            - type: number
            - type: string
              enum:
                - Infinity
                - '-Infinity'
                - NaN
        message:
          type: string
      required:
        - _tag
        - key
        - retryAfterSeconds
        - message
      additionalProperties: false
    IntegrationUnavailableEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - IntegrationUnavailable
        integration:
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - _tag
        - integration
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A workspace API key (Settings → API keys), scoped to `<group>:read` /
        `<group>:write`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.