--- canonical_url: "https://docs.composio.dev/toolkits/firmable" markdown_url: "https://docs.composio.dev/toolkits/firmable.md" product: "platform" version: null last_updated: null --- # Firmable Firmable's Partner API enriches company and people records, searches for people within companies, and returns supported search-filter metadata. - **Category:** business intelligence - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 4 - **Triggers:** 0 - **Slug:** `FIRMABLE` - **Version:** 00000000_00 ## Tools ### Enrich Company **Slug:** `FIRMABLE_ENRICH_COMPANY` Look up one enriched company using at least one Firmable, LinkedIn, domain, ABN, or website identifier. This call may consume Firmable credits; Firmable does not publish a per-call cost. Successful enrichment and identifier precedence were not live-verified to avoid consuming credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `abn` | string | No | Australian Business Number. Provide at least one lookup identifier. | | `domain` | string | No | Fully qualified company domain without a path, such as example.com. Provide at least one lookup identifier. | | `country` | string ("AU" | "NZ" | "SG" | "MY" | "ID" | "PH" | "HK" | "JP" | "VN" | "KR" | "TH" | "US" | "CA") | No | Market for region-specific company data. Defaults to AU. | | `company_id` | string | No | Firmable company ID, such as f000000117274. Provide at least one lookup identifier. | | `website_url` | string | No | Full company website URL. Provide at least one lookup identifier. | | `linkedin_url` | string | No | Full company LinkedIn URL. Provide at least one lookup identifier. | | `linkedin_slug` | string | No | Company LinkedIn slug. Provide at least one lookup identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enrich Person **Slug:** `FIRMABLE_ENRICH_PERSON` Look up one enriched person using a Firmable, LinkedIn, work-email, or personal-email identifier. This request may consume Firmable credits and can return personal contact data; use it only for an authorized purpose. Prefer one strong identifier because precedence between multiple identifiers is not documented or live-verified. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `person_id` | string | No | Firmable person ID, such as fp000000067890. Provide at least one lookup identifier. | | `work_email` | string | No | Person's work email address. Provide at least one lookup identifier. | | `linkedin_url` | string | No | Full person LinkedIn URL. Provide at least one lookup identifier. | | `linkedin_slug` | string | No | Person LinkedIn slug. Provide at least one lookup identifier. | | `personal_email` | string | No | Person's personal email address. Provide at least one lookup identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Filter Options **Slug:** `FIRMABLE_LIST_FILTER_OPTIONS` Return Firmable's current search filter codes and supported markets, optionally selecting filters or paging one location or industry filter. Firmable explicitly documents this read-only endpoint as not charged. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `offset` | integer | No | Number of matching values to skip for exactly one pageable identifier. Omit on the first page and for non-pageable or multiple identifiers; pages contain 20 values. | | `search` | string | No | Case-insensitive code or label search. Valid only with exactly one of industry, location, hq_location, or people_location. | | `identifiers` | array | No | Filter definitions to return. Accepted identifiers: industry, location, hq_location, company_size, global_company_size, revenue, company_type, year_founded, is_mnc, b2b_vs_b2c, target_market, multiple_locations, job_posts, keywords, services, products, position, seniority, department, skills, current_role_duration, and people_location. Pass an array or comma-separated string; omit to return all definitions. | | `level_one_code` | string | No | Top-level industry code whose second-level codes should be listed. Valid only with identifiers=[industry]. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People in Company **Slug:** `FIRMABLE_SEARCH_PEOPLE_IN_COMPANY` Return one offset-based page of people at a Firmable company, optionally filtered by position, country, seniority code, or department code. Each call may consume Firmable credits and can return personal data; use it only for an authorized purpose. Firmable does not publish a per-call cost. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `offset` | integer | No | Zero-based result offset. Pass next_offset from the prior response to continue. | | `country` | string ("AU" | "NZ" | "SG" | "MY" | "ID" | "PH" | "HK" | "JP" | "VN" | "KR" | "TH" | "US" | "CA") | No | Market to search. Defaults to AU. | | `position` | string | No | Job title or position text to match. | | `page_size` | integer | No | Number of people requested in this page. Firmable documents no maximum. | | `company_id` | string | Yes | Firmable company ID whose people should be searched. | | `seniority_code` | string ("1" | "2" | "3" | "4" | "5" | "6" | "7") | No | Numeric-string seniority code from LIST_FILTER_OPTIONS: 1 board/director, 2 owner/founder, 3 C-suite/partner, 4 VP/director/head, 5 manager, 6 other, or 7 no data. | | `department_code` | string ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17") | No | Numeric-string department code from LIST_FILTER_OPTIONS. Use that tool to resolve current labels; documented codes are 1 through 17. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |