> ## 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.
# Intercom Retrieve Company: Inputs, Cost & CLI Example
> Retrieve companies. Intercom Intercom Retrieve Company docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## 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=intercom_retrieve_company:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | ---------------------------------------------------- |
| `payload.name` | `string` | No | | The `name` of the company to filter by. |
| `payload.company_id` | `string` | No | | The `company_id` of the company to filter by. |
| `payload.tag_id` | `string` | No | | The `tag_id` of the company to filter by. |
| `payload.segment_id` | `string` | No | | The `segment_id` of the company to filter by. |
| `payload.page` | `integer` | No | | The page of results to fetch. Defaults to first page |
| `payload.per_page` | `integer` | No | | How many results to display per page. Defaults to 15 |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "You can fetch a single company by passing in `company_id` or `name`. `https://api.intercom.io/companies?name={name}` `https://api.intercom.io/companies?company_id={company_id}` You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. `https://api.intercom.io/companies?tag_id={tag_id}` `https://api.intercom.io/companies?segment_id={segment_id}`",
"properties": {
"name": {
"type": "string",
"description": "The `name` of the company to filter by."
},
"company_id": {
"type": "string",
"description": "The `company_id` of the company to filter by."
},
"tag_id": {
"type": "string",
"description": "The `tag_id` of the company to filter by."
},
"segment_id": {
"type": "string",
"description": "The `segment_id` of the company to filter by."
},
"page": {
"type": "integer",
"description": "The page of results to fetch. Defaults to first page"
},
"per_page": {
"type": "integer",
"description": "How many results to display per page. Defaults to 15"
}
},
"required": [],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ------------------------------------------------- |
| `result.data` | `object` | Yes | | This will return a list of companies for the App. |
| `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": "This will return a list of companies for the App.",
"properties": {
"type": {
"type": "string",
"description": "The type of object - `list`.",
"enum": [
"list"
]
},
"pages": {
"type": [
"object",
"null"
],
"description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.",
"properties": {
"type": {
"type": "string",
"description": "the type of object `pages`.",
"enum": [
"pages"
]
},
"page": {
"type": "integer",
"description": "The current page"
},
"next": {
"type": [
"object",
"null"
],
"properties": {
"per_page": {
"type": "integer",
"description": "The number of results to fetch per page."
},
"starting_after": {
"type": [
"string",
"null"
],
"description": "The cursor to use in the next request to get the next page of results."
}
},
"additionalProperties": false
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_pages": {
"type": "integer",
"description": "Total number of pages"
}
},
"additionalProperties": false
},
"total_count": {
"type": "integer",
"description": "The total number of companies."
},
"data": {
"type": "array",
"description": "An array containing Company Objects.",
"items": {
"type": "object",
"description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.",
"properties": {
"type": {
"type": "string",
"description": "Value is `company`",
"enum": [
"company"
]
},
"id": {
"type": "string",
"description": "The Intercom defined id representing the company."
},
"name": {
"type": "string",
"description": "The name of the company."
},
"app_id": {
"type": "string",
"description": "The Intercom defined code of the workspace the company is associated to."
},
"plan": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Value is always \"plan\""
},
"id": {
"type": "string",
"description": "The id of the plan"
},
"name": {
"type": "string",
"description": "The name of the plan"
}
},
"additionalProperties": false
},
"company_id": {
"type": "string",
"description": "The company id you have defined for the company."
},
"remote_created_at": {
"type": "integer",
"description": "The time the company was created by you."
},
"created_at": {
"type": "integer",
"description": "The time the company was added in Intercom."
},
"updated_at": {
"type": "integer",
"description": "The last time the company was updated."
},
"last_request_at": {
"type": "integer",
"description": "The time the company last recorded making a request."
},
"size": {
"type": "integer",
"description": "The number of employees in the company."
},
"website": {
"type": "string",
"description": "The URL for the company website."
},
"industry": {
"type": "string",
"description": "The industry that the company operates in."
},
"monthly_spend": {
"type": "integer",
"description": "How much revenue the company generates for your business."
},
"session_count": {
"type": "integer",
"description": "How many sessions the company has recorded."
},
"user_count": {
"type": "integer",
"description": "The number of users in the company."
},
"custom_attributes": {
"type": "object",
"description": "The custom attributes you have set on the company.",
"additionalProperties": {
"type": "string"
}
},
"tags": {
"type": "object",
"description": "The list of tags associated with the company",
"properties": {
"type": {
"type": "string",
"description": "The type of the object",
"enum": [
"tag.list"
]
},
"tags": {
"type": "array",
"items": {
"type": "object",
"description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.",
"properties": {
"type": {
"type": "string",
"description": "value is \"tag\""
},
"id": {
"type": "string",
"description": "The id of the tag"
},
"name": {
"type": "string",
"description": "The name of the tag"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"segments": {
"type": "object",
"description": "The list of segments associated with the company",
"properties": {
"type": {
"type": "string",
"description": "The type of the object",
"enum": [
"segment.list"
]
},
"segments": {
"type": "array",
"items": {
"type": "object",
"description": "A segment is a group of your contacts defined by the rules that you set.",
"properties": {
"type": {
"type": "string",
"description": "The type of object.",
"enum": [
"segment"
]
},
"id": {
"type": "string",
"description": "The unique identifier representing the segment."
},
"name": {
"type": "string",
"description": "The name of the segment."
},
"created_at": {
"type": "integer",
"description": "The time the segment was created."
},
"updated_at": {
"type": "integer",
"description": "The time the segment was updated."
},
"person_type": {
"type": "string",
"description": "Type of the contact: contact (lead) or user.",
"enum": [
"contact",
"user"
]
},
"count": {
"type": [
"integer",
"null"
],
"description": "The number of items in the user segment. It's returned when `include_count=true` is included in the request."
}
},
"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 intercom_retrieve_company --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`.