> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Firmable Company Lookup: Inputs, Cost & CLI Example
> Returns company information. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=firmable_company_lookup:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `payload.id` | `string` | No | | The Firmable ID of the company (example: f000000117274) |
| `payload.ln_slug` | `string` | No | | The LinkedIn slug of the company (example: smec) |
| `payload.ln_url` | `string` | No | | LinkedIn URL of the company (example: [https://www.linkedin.com/company/smec/](https://www.linkedin.com/company/smec/)) |
| `payload.fqdn` | `string` | No | | FQDN of the company (example: smec.com) |
| `payload.abn` | `string` | No | | ABN of the company (example: 47065475149) |
| `payload.website` | `string` | No | | Website of the company (example: [https://www.smec.com](https://www.smec.com)) |
| `payload.country` | `"AU" \| "NZ" \| "SG" \| "MY" \| "ID" \| "PH" \| "HK" \| "JP" \| "VN" \| "KR" \| "TH" \| "US" \| "CA"` | No | | ISO country code to return region-specific data for. Supported values: AU, NZ, SG, MY, ID, PH, HK, JP, VN, KR, TH, US, CA. Defaults to AU when not provided. |
### Allowed values
| Field | Allowed values |
| ----------------- | ---------------------------------------------------------------------------- |
| `payload.country` | `AU`, `NZ`, `SG`, `MY`, `ID`, `PH`, `HK`, `JP`, `VN`, `KR`, `TH`, `US`, `CA` |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Returns company information",
"properties": {
"id": {
"type": "string",
"description": "The Firmable ID of the company (example: f000000117274)"
},
"ln_slug": {
"type": "string",
"description": "The LinkedIn slug of the company (example: smec)"
},
"ln_url": {
"type": "string",
"description": "LinkedIn URL of the company (example: https://www.linkedin.com/company/smec/)"
},
"fqdn": {
"type": "string",
"description": "FQDN of the company (example: smec.com)"
},
"abn": {
"type": "string",
"description": "ABN of the company (example: 47065475149)"
},
"website": {
"type": "string",
"description": "Website of the company (example: https://www.smec.com)"
},
"country": {
"type": "string",
"description": "ISO country code to return region-specific data for. Supported values: AU, NZ, SG, MY, ID, PH, HK, JP, VN, KR, TH, US, CA. Defaults to AU when not provided.",
"enum": [
"AU",
"NZ",
"SG",
"MY",
"ID",
"PH",
"HK",
"JP",
"VN",
"KR",
"TH",
"US",
"CA"
]
}
},
"required": [],
"anyOf": [
{
"required": [
"id"
]
},
{
"required": [
"ln_slug"
]
},
{
"required": [
"ln_url"
]
},
{
"required": [
"fqdn"
]
},
{
"required": [
"abn"
]
},
{
"required": [
"website"
]
}
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"id": {
"type": "string",
"description": "The Firmable ID of the company."
},
"name": {
"type": "string",
"description": "The name of the company."
},
"website": {
"type": "string",
"description": "The company's website URL."
},
"fqdn": {
"type": "string",
"description": "The fully qualified domain name of the company's website."
},
"description": {
"type": "string",
"description": "A detailed description of the company."
},
"tagline": {
"type": "string",
"description": "A brief tagline or slogan for the company."
},
"linkedin": {
"type": "string",
"description": "The company's LinkedIn handle."
},
"employee_count": {
"type": [
"integer",
"null"
],
"description": "The number of employees in the requested country region."
},
"year_founded": {
"type": "integer",
"description": "The year the company was founded."
},
"hq_location": {
"type": [
"string",
"null"
],
"description": "The headquarters location of the company."
},
"hq_country": {
"type": "string",
"description": "The country of the company's headquarters."
},
"company_size": {
"type": "string",
"description": "The size category of the company."
},
"company_type": {
"type": "string",
"description": "The type of company (e.g., Private, Public)."
},
"abn_operation_status": {
"type": "string",
"description": "The operational status of the company's ABN."
},
"locations": {
"type": "array",
"description": "The locations associated with the company.",
"items": {
"type": "string"
}
},
"industries": {
"type": "array",
"description": "The industries associated with the company.",
"items": {
"type": "string"
}
},
"revenue": {
"type": "string",
"description": "The company's revenue, if available."
},
"phones": {
"type": "array",
"description": "List of phone numbers associated with the company.",
"items": {
"type": "string"
}
},
"emails": {
"type": "array",
"description": "List of email addresses associated with the company.",
"items": {
"type": "string"
}
},
"social_media": {
"type": "object",
"description": "Social media profiles of the company.",
"properties": {
"twitter": {
"type": [
"string",
"null"
],
"description": "Twitter handle of the company."
},
"youtube": {
"type": [
"string",
"null"
],
"description": "Youtube channel of the company."
},
"facebook": {
"type": [
"string",
"null"
],
"description": "Facebook page of the company."
},
"linkedin": {
"type": [
"string",
"null"
],
"description": "LinkedIn profile of the company."
},
"instagram": {
"type": [
"string",
"null"
],
"description": "Instagram handle of the company."
}
},
"additionalProperties": false
},
"industry_codes": {
"type": "object",
"description": "Industry classification and business identifier codes for the company. Always includes global codes (sic, duns, naics, anzsic) where available. Also includes country-specific business identifiers depending on the requested region — for example: abn and acn for AU, nzbn for NZ, uen for SG. Additional identifiers may be present for other supported countries (MY, ID, PH, HK, JP, VN, KR, TH, US, CA).",
"properties": {
"sic": {
"type": [
"string",
"null"
],
"description": "Standard Industrial Classification code."
},
"duns": {
"type": [
"string",
"null"
],
"description": "Data Universal Numbering System number."
},
"naics": {
"type": [
"string",
"null"
],
"description": "North American Industry Classification System code."
},
"anzsic": {
"type": [
"string",
"null"
],
"description": "Australian and New Zealand Standard Industrial Classification code."
},
"abn": {
"type": [
"string",
"null"
],
"description": "Australian Business Number (AU only)."
},
"acn": {
"type": [
"string",
"null"
],
"description": "Australian Company Number (AU only)."
},
"nzbn": {
"type": [
"string",
"null"
],
"description": "New Zealand Business Number (NZ only)."
},
"uen": {
"type": [
"string",
"null"
],
"description": "Unique Entity Number (SG only)."
}
},
"additionalProperties": {
"type": [
"string",
"null"
],
"description": "Additional country-specific business identifier."
}
},
"keywords": {
"type": "array",
"description": "Keywords associated with the company.",
"items": {
"type": "string"
}
},
"org_registers": {
"type": "object",
"description": "Information about organizational registers.",
"additionalProperties": true
},
"states": {
"type": "array",
"description": "Additional state information about the company.",
"items": {
"type": "string"
}
},
"nextGen": {
"type": "object",
"description": "Next-generation data about the company.",
"properties": {
"technographics": {
"type": "object",
"description": "Technographics profile of the company.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"website": {
"type": "string",
"description": "The company's website URL."
},
"social_media": {
"type": "object",
"description": "Detailed social media information.",
"properties": {
"youtube": {
"type": "object",
"description": "YouTube channel details.",
"properties": {
"profile_name": {
"type": "string"
},
"handle": {
"type": "string"
},
"followers": {
"type": [
"integer",
"null"
]
},
"verified": {
"type": [
"string",
"null"
]
},
"videos": {
"type": [
"integer",
"null"
]
},
"likes": {
"type": [
"integer",
"null"
]
},
"views": {
"type": [
"integer",
"null"
]
},
"subscribers": {
"type": [
"integer",
"null"
]
},
"following": {
"type": [
"integer",
"null"
]
},
"joined": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"instagram": {
"type": "object",
"description": "YouTube channel details.",
"properties": {
"profile_name": {
"type": "string"
},
"handle": {
"type": "string"
},
"followers": {
"type": [
"integer",
"null"
]
},
"verified": {
"type": [
"string",
"null"
]
},
"videos": {
"type": [
"integer",
"null"
]
},
"likes": {
"type": [
"integer",
"null"
]
},
"views": {
"type": [
"integer",
"null"
]
},
"subscribers": {
"type": [
"integer",
"null"
]
},
"following": {
"type": [
"integer",
"null"
]
},
"joined": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"linkedin": {
"type": "object",
"description": "YouTube channel details.",
"properties": {
"profile_name": {
"type": "string"
},
"handle": {
"type": "string"
},
"followers": {
"type": [
"integer",
"null"
]
},
"verified": {
"type": [
"string",
"null"
]
},
"videos": {
"type": [
"integer",
"null"
]
},
"likes": {
"type": [
"integer",
"null"
]
},
"views": {
"type": [
"integer",
"null"
]
},
"subscribers": {
"type": [
"integer",
"null"
]
},
"following": {
"type": [
"integer",
"null"
]
},
"joined": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"facebook": {
"type": "object",
"description": "YouTube channel details.",
"properties": {
"profile_name": {
"type": "string"
},
"handle": {
"type": "string"
},
"followers": {
"type": [
"integer",
"null"
]
},
"verified": {
"type": [
"string",
"null"
]
},
"videos": {
"type": [
"integer",
"null"
]
},
"likes": {
"type": [
"integer",
"null"
]
},
"views": {
"type": [
"integer",
"null"
]
},
"subscribers": {
"type": [
"integer",
"null"
]
},
"following": {
"type": [
"integer",
"null"
]
},
"joined": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"reviews_rating": {
"type": [
"object",
"null"
],
"description": "Company reviews and ratings.",
"properties": {
"ceo_approval": {
"type": "string",
"description": "CEO approval rating."
},
"total_reviews": {
"type": "integer",
"description": "Total number of reviews."
},
"rating": {
"type": "object",
"description": "Detailed ratings across various categories.",
"properties": {
"ceo_approval_rating": {
"type": "string"
},
"career_opportunities_rating": {
"type": "string"
},
"compensation_and_benefits_rating": {
"type": "string"
},
"culture_and_values_rating": {
"type": "string"
},
"diversity_and_inclusion_rating": {
"type": "string"
},
"senior_management_rating": {
"type": "string"
},
"work_life_balance_rating": {
"type": "string"
}
},
"additionalProperties": false
},
"overall_rating": {
"type": [
"string",
"null"
],
"description": "Overall company rating."
},
"employee_rating_id": {
"type": [
"string",
"null"
],
"description": "Employee rating identifier."
},
"recommend_to_friend": {
"type": [
"number",
"null"
],
"description": "Percentage of employees who would recommend the company."
},
"url": {
"type": "string",
"description": "URL to the reviews."
}
},
"additionalProperties": false
},
"id": {
"type": "string",
"description": "The Firmable ID of the company (repeated)."
},
"web_traffic": {
"type": "object",
"description": "Web traffic data.",
"properties": {
"summary": {
"type": "object",
"properties": {
"avg_visit_duration": {
"type": "string"
},
"total_web_visitors": {
"type": "number"
},
"bounce_rate": {
"type": "number"
},
"pages_per_visit": {
"type": "number"
}
},
"additionalProperties": false
},
"traffic_share": {
"type": "object",
"properties": {
"countries": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"organic": {
"type": "number"
},
"paid": {
"type": "number"
}
},
"additionalProperties": false
},
"marketing_channels_distribution": {
"type": "object",
"properties": {
"Direct": {
"type": "number"
},
"Referrals": {
"type": "number"
},
"Search": {
"type": "number"
},
"Social": {
"type": "number"
},
"Mail": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute firmable_company_lookup --payload '{}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.