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

# Hubspot Search Lists: Inputs, Cost & CLI Example

> Search HubSpot lists/segments by name and processing type with limit/offset pagination. Includes inputs, outputs, costs, 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=hubspot_search_lists:{}' --json
```

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

## Input Schema

| Name                       | Type      | Required | Default | Description                                                         |
| -------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------- |
| `payload.query`            | `string`  | No       |         | List name query. Provide an empty string to page through all lists. |
| `payload.object_type_id`   | `string`  | No       |         | HubSpot object type ID, for example `0-1` for contacts.             |
| `payload.processing_types` | `array`   | No       |         | Optional processing types to filter by.                             |
| `payload.limit`            | `integer` | No       |         | Maximum lists to return in one page.                                |
| `payload.offset`           | `integer` | No       |         | Paging offset returned by a previous list search page.              |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Search HubSpot lists/segments by name, object type, and processing type.",
    "properties": {
      "query": {
        "type": "string",
        "description": "List name query. Provide an empty string to page through all lists."
      },
      "object_type_id": {
        "type": "string",
        "description": "HubSpot object type ID, for example `0-1` for contacts."
      },
      "processing_types": {
        "type": "array",
        "description": "Optional processing types to filter by.",
        "items": {
          "type": "string",
          "enum": [
            "MANUAL",
            "DYNAMIC",
            "SNAPSHOT"
          ]
        }
      },
      "limit": {
        "type": "integer",
        "description": "Maximum lists to return in one page.",
        "minimum": 1,
        "maximum": 500
      },
      "offset": {
        "type": "integer",
        "description": "Paging offset returned by a previous list search page.",
        "minimum": 0
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `record` | Yes      |         | Provider response payload.                     |
| `result.meta` | `record` | 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": "Provider response payload.",
        "additionalProperties": {}
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

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

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

## Provider API Context

<details>
  <summary>Show provider reference (optional)</summary>

  ```md theme={null}
  Source: https://developers.hubspot.com/docs/api-reference/crm-lists-v3/lists/post-crm-v3-lists-search

  specs/crm-lists-v3.json post /crm/v3/lists/search
  Search lists by list name or page through all lists by providing an empty `query` value.

  &lt;AccordionGroup>
    &lt;Accordion title="Supported products" icon="cubes">
      &lt;SupportedProducts />
    &lt;/Accordion>

    &lt;Accordion title="Required Scopes" icon="key">
      &lt;ScopesList />
    &lt;/Accordion>
  &lt;/AccordionGroup>
  ```
</details>

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