Intercom: List Attached Segments For Companies

List the segments a company belongs to in Intercom.

Tool ID: intercom_list_attached_segments_for_companies

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);

CLI

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

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "list",
    "data": [
      {
        "type": "segment",
        "id": "id_123",
        "name": "Example"
      }
    ]
  }
}

Use deepline describe intercom_list_attached_segments_for_companies --json for the latest machine-readable contract.

Input reference

You can fetch a list of all segments that belong to a 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	—	A list of Segment Objects
`result.data.type`	`"list"`	No	—	The type of object - `list` Allowed: `list`.
`result.data.data`	`array`	No	—	An array containing Segment Objects
`result.data.data[].type`	`"segment"`	No	—	The type of object. Allowed: `segment`.
`result.data.data[].id`	`string`	No	—	The unique identifier representing the segment.
`result.data.data[].name`	`string`	No	—	The name of the segment.
`result.data.data[].created_at`	`integer`	No	—	The time the segment was created.
`result.data.data[].updated_at`	`integer`	No	—	The time the segment was updated.
`result.data.data[].person_type`	`"contact" \| "user"`	No	—	Type of the contact: contact (lead) or user. Allowed: `contact`, `user`.
`result.data.data[].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.

​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