Skip to main content
GET
/
company-settings
Get company settings
curl --request GET \
  --url https://ai-api.getbreezyapp.com/api/v1/company-settings \
  --header 'Authorization: Bearer <token>'
{
  "profile": {
    "companyName": "<string>",
    "companyDescription": "<string>",
    "primaryPhoneNumber": "<string>",
    "companyTimezone": "<string>",
    "companyWebsite": "<string>",
    "industries": [],
    "facebookUrl": "<string>",
    "instagramUrl": "<string>",
    "linkedinUrl": "<string>",
    "logoImageUrl": "<string>",
    "publicContactEmail": "jsmith@example.com"
  },
  "jobTypes": [
    {
      "id": "<string>",
      "enabled": true,
      "name": "<string>",
      "description": "<string>",
      "customerFacingName": "<string>",
      "fsmStaleReason": "<string>",
      "fsmHealthLastCheckedAt": "<string>"
    }
  ],
  "businessHours": {
    "monday": {
      "startTime": "<string>",
      "endTime": "<string>"
    },
    "tuesday": {
      "startTime": "<string>",
      "endTime": "<string>"
    },
    "wednesday": {
      "startTime": "<string>",
      "endTime": "<string>"
    },
    "thursday": {
      "startTime": "<string>",
      "endTime": "<string>"
    },
    "friday": {
      "startTime": "<string>",
      "endTime": "<string>"
    },
    "saturday": {
      "startTime": "<string>",
      "endTime": "<string>"
    },
    "sunday": {
      "startTime": "<string>",
      "endTime": "<string>"
    }
  },
  "notificationPreferences": {
    "emailAddresses": [
      "<string>"
    ],
    "phoneNumbers": [
      "<string>"
    ]
  },
  "faqs": [
    {
      "id": "<string>",
      "question": "<string>",
      "answer": "<string>"
    }
  ],
  "leadSources": [
    {
      "id": "<string>",
      "name": "<string>",
      "archived": true,
      "isExistingCustomerSource": true,
      "createdAt": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Auth0 user JWT bearer token. User principals can manage API keys and call tenant-scoped customer endpoints.

Response

200 - application/json

OK

profile
object
required
read-only

Company profile

jobTypes
object[]
required
businessHours
object
required
read-only
notificationPreferences
object
required
read-only
faqs
object[]
required
leadSources
object[]
required