Company

A client company in your CRM. Deals, projects and invoices all belong to one.

  • archived_at
    Type: string | nullFormat: date-time
    required

    When the company was archived, or null while it is active. Archived companies are left out of the list endpoint.

  • avatar_url
    Type: string | null
    required

    Link to the company's logo, or null when it has none. Read-only — the create and update endpoints don't accept it. Bonsai shows generated initials in the app when there is no logo; those are never returned here.

  • company_size
    Type: string | nullenum
    required

    Headcount band for the company, or null when unset. One of a fixed list.

    values
    size_1_10size_11_50size_51_200size_201_1000size_1000_plusnull
  • created_at
    Type: stringFormat: date-time
    required

    When the company was added to your account.

  • default_contact_id
    Type: integer | null
    required

    Id of the contact treated as this company's primary point of contact, or null when none is set. Deals and invoices created without an explicit contact fall back to it.

  • description
    Type: string | null
    required

    Free text notes about the company, or null when unset.

  • domains
    Type: array of string
    required

    Domains associated with the company, lowercased and stripped of any protocol or www. prefix. A domain can belong to only one company in your account.

  • facebook
    Type: string | null
    required

    Link to the company's Facebook page, or null when unset.

  • id
    Type: integer
    required

    Unique identifier for the company.

  • industry
    Type: string | nullenum
    required

    The industry the company operates in, or null when unset. One of a fixed list.

    values
    • arts_and_entertainment
    • business_and_consumer_services
    • community_and_society
    • computers_electronics_and_technology
    • e_commerce_and_shopping
    • finance
    • food_and_drink
    • gambling
  • instagram
    Type: string | null
    required

    Link to the company's Instagram profile, or null when unset.

  • linkedin
    Type: string | null
    required

    Link to the company's LinkedIn profile, or null when unset.

  • name
    Type: string | null
    required

    Company name.

  • source
    Type: string | nullenum
    required

    How the client was acquired, or null when unset. One of a fixed list.

    values
    organic_searchpaid_searchemail_marketingorganic_socialreferralsother_campaignsdirect_trafficoffline_sourcespaid_socialai_referralsnull
  • twitter
    Type: string | null
    required

    Link to the company's X profile, or null when unset.

  • url
    Type: string
    required

    Absolute link to the company in the Bonsai app. Share it to send someone straight to the record.