> ## 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 List Segments: Inputs, Cost & CLI Example

> List all segments. Intercom Intercom List Segments docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_list_segments:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                    | Type      | Required | Default | Description                                                    |
| ----------------------- | --------- | -------- | ------- | -------------------------------------------------------------- |
| `payload.include_count` | `boolean` | No       |         | It includes the count of contacts that belong to each segment. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "You can fetch a list of all segments.",
    "properties": {
      "include_count": {
        "type": "boolean",
        "description": "It includes the count of contacts that belong to each segment."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                                                                                       |
| ------------- | -------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes      |         | This will return a list of Segment Objects. The result may also have a pages object if the response is paginated. |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging).                                                                    |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the object",
            "enum": [
              "segment.list"
            ]
          },
          "segments": {
            "type": "array",
            "description": "A list of Segment objects",
            "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
            }
          },
          "pages": {
            "type": "object",
            "description": "A pagination object, which may be empty, indicating no further pages to fetch."
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute intercom_list_segments --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`.