Intercom: Retrieve Acompany By ID

Retrieve a company by ID.

Tool ID: intercom_retrieve_acompany_by_id

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_retrieve_acompany_by_id',
  {
    "company_id": "company_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_retrieve_acompany_by_id --input '{
  "company_id": "company_123"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "type": "company",
    "id": "id_123",
    "name": "Example"
  }
}

Use deepline tools get intercom_retrieve_acompany_by_id --json for the latest machine-readable contract.

Input reference

You can fetch a single company.

Name	Type	Required	Default	Details
`payload.company_id`	`string`	Yes	—	The unique identifier for the company which is given by Intercom

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	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.
`result.data.type`	`"company"`	No	—	Value is `company` Allowed: `company`.
`result.data.id`	`string`	No	—	The Intercom defined id representing the company.
`result.data.name`	`string`	No	—	The name of the company.
`result.data.app_id`	`string`	No	—	The Intercom defined code of the workspace the company is associated to.
`result.data.plan`	`object`	No	—	—
`result.data.plan.type`	`string`	No	—	Value is always “plan”
`result.data.plan.id`	`string`	No	—	The id of the plan
`result.data.plan.name`	`string`	No	—	The name of the plan
`result.data.company_id`	`string`	No	—	The company id you have defined for the company.
`result.data.remote_created_at`	`integer`	No	—	The time the company was created by you.
`result.data.created_at`	`integer`	No	—	The time the company was added in Intercom.
`result.data.updated_at`	`integer`	No	—	The last time the company was updated.
`result.data.last_request_at`	`integer`	No	—	The time the company last recorded making a request.
`result.data.size`	`integer`	No	—	The number of employees in the company.
`result.data.website`	`string`	No	—	The URL for the company website.
`result.data.industry`	`string`	No	—	The industry that the company operates in.
`result.data.monthly_spend`	`integer`	No	—	How much revenue the company generates for your business.
`result.data.session_count`	`integer`	No	—	How many sessions the company has recorded.
`result.data.user_count`	`integer`	No	—	The number of users in the company.
`result.data.custom_attributes`	`record`	No	—	The custom attributes you have set on the company.
`result.data.tags`	`object`	No	—	The list of tags associated with the company
`result.data.tags.type`	`"tag.list"`	No	—	The type of the object Allowed: `tag.list`.
`result.data.tags.tags`	`array`	No	—	—
`result.data.tags.tags[].type`	`string`	No	—	value is “tag”
`result.data.tags.tags[].id`	`string`	No	—	The id of the tag
`result.data.tags.tags[].name`	`string`	No	—	The name of the tag
`result.data.segments`	`object`	No	—	The list of segments associated with the company
`result.data.segments.type`	`"segment.list"`	No	—	The type of the object Allowed: `segment.list`.
`result.data.segments.segments`	`array`	No	—	—
`result.data.segments.segments[].type`	`"segment"`	No	—	The type of object. Allowed: `segment`.
`result.data.segments.segments[].id`	`string`	No	—	The unique identifier representing the segment.
`result.data.segments.segments[].name`	`string`	No	—	The name of the segment.
`result.data.segments.segments[].created_at`	`integer`	No	—	The time the segment was created.
`result.data.segments.segments[].updated_at`	`integer`	No	—	The time the segment was updated.
`result.data.segments.segments[].person_type`	`"contact" \| "user"`	No	—	Type of the contact: contact (lead) or user. Allowed: `contact`, `user`.
`result.data.segments.segments[].count`	`integer \| null`	No	—	The number of items in the user segment. It’s returned when `include_count=true` is included in the request.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Intercom: Retrieve Acompany By ID

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation