> ## 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 Segment

> Get an Intercom segment by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get an Intercom segment by its ID.

> [!NOTE]
>
> Tool ID: `intercom_retrieve_segment`

## 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_retrieve_segment',
  {
    "segment_id": "segment_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_retrieve_segment --input '{
  "segment_id": "segment_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "segment",
    "id": "id_123",
    "name": "Example"
  }
}
```

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

## Input reference

You can fetch the details of a single segment.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.segment_id` | `string` | Yes | — | The unique identified of a given segment. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can fetch the details of a single segment.",
    "properties": {
      "segment_id": {
        "type": "string",
        "description": "The unique identified of a given segment."
      }
    },
    "required": [
      "segment_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A segment is a group of your contacts defined by the rules that you set. |
| `result.data.type` | `"segment"` | No | — | The type of object. Allowed: `segment`. |
| `result.data.id` | `string` | No | — | The unique identifier representing the segment. |
| `result.data.name` | `string` | No | — | The name of the segment. |
| `result.data.created_at` | `integer` | No | — | The time the segment was created. |
| `result.data.updated_at` | `integer` | No | — | The time the segment was updated. |
| `result.data.person_type` | `"contact" \| "user"` | No | — | Type of the contact: contact (lead) or user. Allowed: `contact`, `user`. |
| `result.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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "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
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.