> ## 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. # Crustdata Company Enrichment: Inputs, Cost & CLI Example > Running broader company enrichment with CrustData fields. 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=crustdata_company_enrichment:{"companyDomain":"example.com"}' --json ``` Map payload values to spreadsheet columns with `{{column_name}}` placeholders. ## Input Schema | Name | Type | Required | Default | Description | | ---------------------------- | --------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `payload.companyDomain` | `string \| array` | No | | Company website domain(s). | | `payload.companyName` | `string \| array` | No | | Company name(s). | | `payload.companyLinkedinUrl` | `string \| array` | No | | LinkedIn company URL(s). | | `payload.companyId` | `number \| string \| array` | No | | CrustData company ID(s). | | `payload.fields` | `string \| array` | No | | Fields to return (array or comma-separated). Supported documented values include headcount, funding\_and\_investment, linkedin\_followers, job\_openings, web\_traffic, g2, glassdoor, gartner, producthunt, taxonomy, competitors, founders.profiles, founders.founders\_locations, cxos, decision\_makers, all\_office\_addresses, and gartner.\* nested fields. | | `payload.exactMatch` | `boolean` | No | | Require exact domain match for lookups. | | `payload.enrichRealtime` | `boolean` | No | `false` | Trigger realtime enrichment. Very expensive. Default false; never recommend unless the user explicitly asks for realtime enrichment. |
Show raw input schema ### Input JSON Schema ```json theme={null} { "type": "object", "description": "Looks up a company by domain, name, LinkedIn URL, or ID using /screener/company.", "properties": { "companyDomain": { "description": "Company website domain(s).", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } } ] }, "companyName": { "description": "Company name(s).", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } } ] }, "companyLinkedinUrl": { "description": "LinkedIn company URL(s).", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } } ] }, "companyId": { "description": "CrustData company ID(s).", "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 }, { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] } } ] }, "fields": { "description": "Fields to return (array or comma-separated). Supported documented values include headcount, funding_and_investment, linkedin_followers, job_openings, web_traffic, g2, glassdoor, gartner, producthunt, taxonomy, competitors, founders.profiles, founders.founders_locations, cxos, decision_makers, all_office_addresses, and gartner.* nested fields.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } } ] }, "exactMatch": { "type": "boolean", "description": "Require exact domain match for lookups." }, "enrichRealtime": { "type": "boolean", "description": "Trigger realtime enrichment. Very expensive. Default false; never recommend unless the user explicitly asks for realtime enrichment.", "default": false } }, "additionalProperties": false } ```
## Output Schema | Name | Type | Required | Default | Description | | --------------- | -------- | -------- | ------- | ----------- | | `result.status` | `string` | Yes | | | | `result.result` | `object` | Yes | | |
Show raw output schema ### Output JSON Schema ```json theme={null} { "type": "object", "properties": { "status": { "type": "string" }, "result": { "type": "object", "properties": { "data": { "type": "object", "properties": { "company_name": { "type": "string" }, "company_domain": { "type": "string" }, "description": { "type": "string" }, "industry": { "type": "string" }, "employee_count": { "type": "integer" }, "founded_year": { "type": "integer" }, "location": { "type": "string" }, "linkedin_url": { "type": "string" } }, "required": [ "company_name", "company_domain", "description", "industry", "employee_count", "founded_year", "location", "linkedin_url" ], "additionalProperties": true } }, "required": [ "data" ], "additionalProperties": true } }, "required": [ "status", "result" ], "additionalProperties": true } ```
## Advanced: Direct CLI Use direct execution for single payload debugging. ```bash theme={null} deepline tools execute crustdata_company_enrichment --payload '{ "companyDomain": "example.com" }' --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. | ## Provider API Context
Show provider reference (optional) ````md theme={null} ### [ 🚀 Try Now ](https://docs.crustdata.com/api#tag/company-apis/GET/screener/company) This endpoint enriches company data by retrieving detailed information about one or multiple companies using either their domain, name, or ID. ## Endpoint ``` GET /screener/company ``` ## Data Dictionary [Explore the data dictionary for this endpoint here](https://docs.crustdata.com/docs/2024-11-01/dictionary/company-enrichment) ## Request Parameters | Field | Type | Example | Description | | ---------------------- | ------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `company_domain` | string | `company_domain=crustdata.com,google.com` | The domain(s) of the company(ies) you want to retrieve data for. Accepts comma-separated list of up to 25 domains. | | `company_name` | string | `company_name="Acme, Inc.","Widget Co"` | The name(s) of the company(ies) you want to retrieve data for. Accepts comma-separated list of up to 25 names. Use double quotes if names contain commas. | | `company_linkedin_url` | string | `company_linkedin_url=` `https://linkedin.com/company/hubspot` | The LinkedIn URL(s) of the company(ies). Accepts comma-separated list of up to 25 URLs. | | `company_id` | integer | `company_id=12345,67890` | The unique ID(s) of the company(ies) you want to retrieve data for. Accepts comma-separated list of up to 25 IDs. | | `fields` | string | `fields=headcount,funding_and_investment` | Specifies which fields to include in the response. If not provided, returns basic company info and firmographics only. [See all fields](https://docs.crustdata.com/docs/2024-11-01/dictionary/company-enrichment) | | `enrich_realtime` | boolean | `enrich_realtime=true` | When True and the requested company is not present in Crustdata's database, the company is enriched within 10 minutes of the request. Default: False | | `exact_match` | boolean | `exact_match=true` | Determines whether the company identifier should be matched exactly (true) or by the best match logic (false). Default: False | :::tip The `fields` parameter allows you to customize the response by specifying exactly which fields you want to retrieve. This can help reduce payload size and improve performance. - **Default behavior**: Without the `fields` parameter, only basic company information and select firmographics are returned - **With fields parameter**: Returns only the explicitly requested fields - **Nested Fields:** You can specify nested fields up to the levels defined in the response structure (see [available fields here](https://docs.crustdata.com/docs/2024-11-01/dictionary/company-enrichment)). Fields nested beyond the allowed levels or within lists (arrays) cannot be individually accessed. - **User Permissions:** Access to certain fields may be restricted based on your user permissions. If you request fields you do not have access to, the API will return an error indicating unauthorized access. ::: ### Important: Fields Parameter Usage #### Default Response Behavior Without the `fields` parameter, the API returns only: - Basic company information (company_id, company_name, domains, LinkedIn info, etc.) - Select firmographics fields (headquarters, year_founded, revenue estimates, etc.) - **NO nested objects** (headcount, web_traffic, funding, glassdoor, etc.) #### Getting Additional Data To retrieve nested data objects like headcount, web_traffic, or funding information, you MUST explicitly include them in the `fields` parameter: - Example: `fields=headcount,web_traffic,funding_and_investment` - This returns ONLY the specified fields ### Replicating Previous Default Behavior To get the same fields that were returned by default before this update, use this request: ```bash curl 'https://api.crustdata.com/screener/company?company_domain=example.com&fields=headcount,competitors,funding_and_investment,g2,gartner,glassdoor,job_openings,linkedin_followers,news_articles,producthunt,seo,taxonomy,web_traffic,founders.founders_locations,founders.founders_education_institute,founders.founders_degree_name,founders.founders_previous_companies,founders.founders_previous_titles' \ --header 'Authorization: Token $authToken' ``` **Additional fields available:** The above excludes `decision_makers`, `founders.profiles` (detailed profiles), and `cxos` which were not in the previous default. To include these as well: ```bash curl 'https://api.crustdata.com/screener/company?company_domain=example.com&fields=headcount,competitors,funding_and_investment,g2,gartner,glassdoor,job_openings,linkedin_followers,news_articles,producthunt,seo,taxonomy,web_traffic,decision_makers,founders,cxos' \ --header 'Authorization: Token $authToken' ``` ## Credit Usage - **Database Enrichment**: 1 credit per company - **Real-Time Enrichment** (`enrich_realtime=True`): 5 credits per company (4+1) - **No Results, No Charges**: You are never charged credits when our APIs return no results. Credits are only deducted when data is successfully returned from your API requests. ## Example Requests <details id="1-enrich-by-linkedin-profile-url"> <summary>1. Enrich by LinkedIn profile URL</summary> ### 1. Enrich by LinkedIn profile URL ```curl curl 'https://api.crustdata.com/screener/company?company_linkedin_url=https://www.linkedin.com/company/mintlify' \ --header 'Authorization: Token $authToken' ``` </details> <details id="2-enrich-by-domain-with-fields-and-exact-match"> <summary>2. Enrich by Domain w/ Fields & Exact Match</summary> ### 2. Enrich by Domain w/ Fields & Exact Match ```curl curl 'https://api.crustdata.com/screener/company?fields=headcount,founders.profiles,funding_and_investment&exact_match=true&company_domain=retool.com,mintlify.com' \ --header 'Authorization: Token $authToken' ``` Key features: - `fields=headcount,founders.profiles,funding_and_investment` - Returns only specified fields - `exact_match=true` - Matches domains exactly, not as substrings <Note> Provider reference truncated for page speed. Use the provider's official docs for the full upstream reference. </Note> ````
## Cost * Pricing model: `per_result` (per result). * Estimated Deepline credits: `0.4` per pricing unit. * Billing mode: `post_deduct`.