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

# Company enrichment

> Get one company's full profile for one market, contact details included

Contact details are held per market, so the profile is for the market in `country` (default `AU`).

Send exactly one identifier: `id`, `domain`, `website`, `abn`, `ln_slug` or `ln_url`. An ABN can
belong to several Firmable companies, so prefer `id`, `domain` or `website`. Get a company's `id`
from [company search](https://docs.firmable.com/partner/company-search.md).

`required` takes the same values as
[people enrichment](https://docs.firmable.com/partner/people-enrichment.md#the-required-parameter).

> [!NOTE]
>
> Company records don't distinguish mobiles from landlines. `required=mobile` matches any company
> phone number.


## OpenAPI

````yaml GET /partner/{partner}/companies/enrich
openapi: 3.0.1
info:
  title: Firmable API
  description: >-
    The Firmable API provides access to company and people data across multiple
    countries including Australia, New Zealand, Singapore, Malaysia, Indonesia,
    Philippines, Hong Kong, Japan, Vietnam, South Korea, Thailand, United
    States, and Canada. Use it to look up company profiles, retrieve contact
    information, and search for people by company, position, seniority, and
    department.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.firmable.com
security:
  - bearerAuth: []
paths:
  /partner/{partner}/companies/enrich:
    get:
      description: >-
        Returns one company's full profile for one market, contact details
        included. Send exactly one identifier.
      parameters:
        - name: partner
          in: path
          required: true
          description: >-
            Your platform's identifier. Firmable gives it to you during
            onboarding.
          schema:
            type: string
        - name: id
          in: query
          description: >-
            Firmable company id, starting f, from company search. (example:
            f000000000101)
          schema:
            type: string
        - name: domain
          in: query
          description: 'Company domain. (example: harbourline.example)'
          schema:
            type: string
        - name: website
          in: query
          description: Company website.
          schema:
            type: string
        - name: abn
          in: query
          description: >-
            Australian Business Number. An ABN can belong to several Firmable
            companies, so prefer id, domain or website.
          schema:
            type: string
        - name: ln_slug
          in: query
          description: LinkedIn company slug.
          schema:
            type: string
        - name: ln_url
          in: query
          description: LinkedIn company URL.
          schema:
            type: string
        - name: required
          in: query
          required: true
          description: >-
            The contact data the company must have. mobile: a phone number.
            email: a work email. either: a phone number or a work email. both: a
            phone number and a work email. When the requirement isn't met, no
            record is returned and nothing is charged.
          schema:
            type: string
            enum:
              - mobile
              - email
              - either
              - both
        - name: country
          in: query
          description: The market the profile and contact details are for. Defaults to AU.
          schema:
            type: string
            enum:
              - AU
              - NZ
              - SG
              - MY
              - ID
              - PH
              - TH
              - VN
              - HK
              - JP
              - KR
              - US
              - CA
            default: AU
      responses:
        '200':
          description: The company's full profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerCompany'
              example:
                id: f000000000101
                name: Harbourline Logistics
                website: https://www.harbourline.example
                fqdn: harbourline.example
                description: >-
                  Harbourline Logistics provides freight forwarding and
                  cold-chain warehousing across south-east Australia.
                linkedin: harbourline-logistics
                employee_count: 312
                company_size: 251 - 500
                company_type: Private company
                year_founded: 1998
                revenue: $10M - $50M
                industries:
                  - Logistics and supply chain services
                  - Warehousing and storage
                industry_codes:
                  anzsic: '5290'
                  naics: '4885'
                  sic: '4731'
                  abn: '00000000000'
                  acn: '000000000'
                  duns: null
                hq_country: AU
                hq_location: 100 Example St, Port Melbourne, VIC, 3207, AU
                locations:
                  - Port Melbourne, VIC, 3207
                  - Altona, VIC, 3018
                keywords:
                  - freight forwarding
                  - cold chain
                  - warehousing
                phones: null
                emails:
                  - sales@harbourline.example
                nextGen:
                  technographics:
                    Analytics:
                      - Google Tag Manager
                    Content & Media:
                      - WordPress
        '401':
          description: Missing or invalid API key
components:
  schemas:
    PartnerCompany:
      type: object
      properties:
        id:
          type: string
          description: Firmable company id
        name:
          type: string
          description: Company name
        website:
          type: string
          description: Website
        fqdn:
          type: string
          description: Domain
        description:
          type: string
          description: Company description
        linkedin:
          type: string
          description: LinkedIn company slug
        employee_count:
          type: integer
          description: Employee count in the market
        company_size:
          type: string
          description: Employee count band
        company_type:
          type: string
          description: Company type
        year_founded:
          type: integer
          description: Year founded
        revenue:
          type: string
          description: Revenue band
        industries:
          type: array
          items:
            type: string
          description: Industry labels
        industry_codes:
          type: object
          description: Industry classification and registry codes
          properties:
            anzsic:
              type: string
              description: ANZSIC code
            naics:
              type: string
              description: NAICS code
            sic:
              type: string
              description: SIC code
            abn:
              type: string
              description: Australian Business Number
            acn:
              type: string
              description: Australian Company Number
            duns:
              type: string
              nullable: true
              description: D-U-N-S number
        hq_country:
          type: string
          description: Headquarters market code
        hq_location:
          type: string
          description: Headquarters address
        locations:
          type: array
          items:
            type: string
          description: Locations in the market
        keywords:
          type: array
          items:
            type: string
          description: Keywords
        phones:
          type: array
          nullable: true
          items:
            type: string
          description: Company phone numbers in the market
        emails:
          type: array
          nullable: true
          items:
            type: string
          description: Company emails in the market
        nextGen:
          type: object
          properties:
            technographics:
              type: object
              description: Technologies used, keyed by category
              additionalProperties:
                type: array
                items:
                  type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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