> ## Documentation Index
> Fetch the complete documentation index at: https://ai-api-docs.getbreezyapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get company settings



## OpenAPI

````yaml /openapi.public.json get /company-settings
openapi: 3.1.1
info:
  title: Breezy Public API
  version: 1.0.0
  description: Curated Breezy customer API for user JWT and service API key clients.
servers:
  - url: https://ai-api.getbreezyapp.com/api/v1
    description: Production
security:
  - userJwtBearer: []
  - serviceApiKeyBearer: []
tags:
  - name: API Keys
    description: Create, list, reveal, and revoke service API keys.
  - name: Company Settings
    description: Read and update tenant company settings and service zones.
  - name: Contacts
    description: Read contacts and update customer attribution fields.
  - name: Service Requests
    description: Read and triage customer service requests.
  - name: Users
    description: Read public user identity and team user records.
  - name: Webhooks
    description: Create, update, rotate, and delete webhook endpoints.
paths:
  /company-settings:
    get:
      tags:
        - Company Settings
      summary: Get company settings
      operationId: companySettings.get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  profile:
                    type: object
                    properties:
                      companyName:
                        type: string
                        description: Company name
                      companyDescription:
                        type: string
                        description: Company description
                      primaryPhoneNumber:
                        type: string
                        description: Primary phone number
                      companyWebsite:
                        type: string
                        description: Company website URL
                      companyTimezone:
                        type: string
                        description: Company timezone
                      industries:
                        type: array
                        items:
                          enum:
                            - hvac
                            - electrical
                            - plumbing
                            - appliance_repair
                            - security_services
                            - pest_control
                            - crawl_space_encapsulation
                            - mold_remediation
                            - unknown
                          type: string
                        default: []
                        description: Industries
                      facebookUrl:
                        type: string
                        description: Facebook URL
                      instagramUrl:
                        type: string
                        description: Instagram URL
                      linkedinUrl:
                        type: string
                        description: LinkedIn URL
                      logoImageUrl:
                        type: string
                        description: Logo image URL
                      publicContactEmail:
                        type: string
                        format: email
                        description: Public contact email for booking pages
                    required:
                      - companyName
                      - companyDescription
                      - primaryPhoneNumber
                      - companyTimezone
                    description: Company profile
                    readOnly: true
                  jobTypes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: >-
                            ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
                          description: Unique identifier (UUID)
                        enabled:
                          type: boolean
                        name:
                          type: string
                        customerFacingName:
                          type: string
                        description:
                          type: string
                        industry:
                          enum:
                            - hvac
                            - electrical
                            - plumbing
                            - appliance_repair
                            - security_services
                            - pest_control
                            - crawl_space_encapsulation
                            - mold_remediation
                            - unknown
                          type: string
                        jobClass:
                          enum:
                            - maintenance
                            - service_and_repair
                            - installs_and_replacement
                            - sales
                            - inspection
                            - treatment
                            - monitoring_activation
                            - unknown
                          type: string
                        fsmLinkStatus:
                          enum:
                            - linked
                            - not_linked
                            - stale
                          type: string
                        fsmStaleReason:
                          type: string
                        fsmHealthLastCheckedAt:
                          type: string
                      required:
                        - id
                        - enabled
                        - name
                        - description
                        - industry
                        - jobClass
                      readOnly: true
                  businessHours:
                    type: object
                    properties:
                      monday:
                        type: object
                        properties:
                          startTime:
                            type: string
                          endTime:
                            type: string
                        readOnly: true
                      tuesday:
                        type: object
                        properties:
                          startTime:
                            type: string
                          endTime:
                            type: string
                        readOnly: true
                      wednesday:
                        type: object
                        properties:
                          startTime:
                            type: string
                          endTime:
                            type: string
                        readOnly: true
                      thursday:
                        type: object
                        properties:
                          startTime:
                            type: string
                          endTime:
                            type: string
                        readOnly: true
                      friday:
                        type: object
                        properties:
                          startTime:
                            type: string
                          endTime:
                            type: string
                        readOnly: true
                      saturday:
                        type: object
                        properties:
                          startTime:
                            type: string
                          endTime:
                            type: string
                        readOnly: true
                      sunday:
                        type: object
                        properties:
                          startTime:
                            type: string
                          endTime:
                            type: string
                        readOnly: true
                    required:
                      - monday
                      - tuesday
                      - wednesday
                      - thursday
                      - friday
                      - saturday
                      - sunday
                    readOnly: true
                  notificationPreferences:
                    type: object
                    properties:
                      emailAddresses:
                        type: array
                        items:
                          type: string
                      phoneNumbers:
                        type: array
                        items:
                          type: string
                      serviceRequests:
                        enum:
                          - none
                          - email
                          - sms
                          - email_and_sms
                        type: string
                      customerSupport:
                        enum:
                          - none
                          - email
                          - sms
                          - email_and_sms
                        type: string
                      otherConversations:
                        enum:
                          - none
                          - email
                          - sms
                          - email_and_sms
                        type: string
                      afterHoursRouting:
                        type: object
                        properties:
                          serviceRequests:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                              smsDestinationMode:
                                enum:
                                  - on_call_schedule
                                  - specific_numbers
                                type: string
                              specificPhoneNumbers:
                                type: array
                                items:
                                  type: string
                              emailAddresses:
                                type: array
                                items:
                                  type: string
                                  format: email
                              recipientMode:
                                enum:
                                  - replaced
                                  - also_notified
                                type: string
                            required:
                              - enabled
                              - smsDestinationMode
                              - specificPhoneNumbers
                              - emailAddresses
                              - recipientMode
                            additionalProperties: false
                            readOnly: true
                          customerSupport:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                              smsDestinationMode:
                                enum:
                                  - on_call_schedule
                                  - specific_numbers
                                type: string
                              specificPhoneNumbers:
                                type: array
                                items:
                                  type: string
                              emailAddresses:
                                type: array
                                items:
                                  type: string
                                  format: email
                              recipientMode:
                                enum:
                                  - replaced
                                  - also_notified
                                type: string
                            required:
                              - enabled
                              - smsDestinationMode
                              - specificPhoneNumbers
                              - emailAddresses
                              - recipientMode
                            additionalProperties: false
                            readOnly: true
                          otherConversations:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                              smsDestinationMode:
                                enum:
                                  - on_call_schedule
                                  - specific_numbers
                                type: string
                              specificPhoneNumbers:
                                type: array
                                items:
                                  type: string
                              emailAddresses:
                                type: array
                                items:
                                  type: string
                                  format: email
                              recipientMode:
                                enum:
                                  - replaced
                                  - also_notified
                                type: string
                            required:
                              - enabled
                              - smsDestinationMode
                              - specificPhoneNumbers
                              - emailAddresses
                              - recipientMode
                            additionalProperties: false
                            readOnly: true
                        required:
                          - serviceRequests
                          - customerSupport
                          - otherConversations
                        additionalProperties: false
                        readOnly: true
                      suppressedEmailAddresses:
                        type: array
                        items:
                          type: string
                    required:
                      - emailAddresses
                      - phoneNumbers
                      - serviceRequests
                      - customerSupport
                      - otherConversations
                    readOnly: true
                  faqs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: >-
                            ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
                          description: Unique identifier (UUID)
                        question:
                          type: string
                        answer:
                          type: string
                        category:
                          enum:
                            - general
                            - services
                            - billing
                            - technical
                          type: string
                      required:
                        - id
                        - question
                        - answer
                        - category
                      readOnly: true
                  leadSources:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: >-
                            ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
                          description: Unique identifier (UUID)
                        name:
                          type: string
                        archived:
                          type: boolean
                        isExistingCustomerSource:
                          type: boolean
                        createdAt:
                          type: string
                      required:
                        - id
                        - name
                        - archived
                        - isExistingCustomerSource
                        - createdAt
                      readOnly: true
                required:
                  - profile
                  - jobTypes
                  - businessHours
                  - notificationPreferences
                  - faqs
                  - leadSources
                additionalProperties: false
                readOnly: true
      security:
        - userJwtBearer: []
        - serviceApiKeyBearer: []
components:
  securitySchemes:
    userJwtBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User JWT bearer token. User principals can manage API keys and call
        tenant-scoped customer endpoints.
    serviceApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: bzy_live_...
      description: >-
        Service API key bearer token beginning with bzy_live_. Service API keys
        use tenant scope and cannot manage API keys or call user-only endpoints.

````