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

# Close CRM: Close List Leads

> Read existing company leads from Close CRM for a sync. list one page of companies and their lead statuses. Includes SDK V2 examples, schemas, and cost.

Read existing company leads from Close CRM for a sync. list one page of companies and their lead statuses.

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

## 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(
  'close_list_leads',
  {
    "_limit": 100,
    "_skip": 0,
    "_fields": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run close_list_leads --input '{
  "_limit": 100,
  "_skip": 0,
  "_fields": "example"
}'
```

## 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": {
    "data": [
      {
        "contact_ids": [
          "contact_123"
        ],
        "contacts": [
          {}
        ]
      }
    ],
    "has_more": true
  }
}
```

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

## Input reference

Read one page of Close CRM leads (companies or organizations). Use \_limit and \_skip for pagination and has\_more to see whether another page exists. Use \_fields to request selected fields. Read-only. This does not create or update records.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload._limit` | `integer` | No | `100` | Number of results to return. |
| `payload._skip` | `integer` | No | `0` | Number of results to skip before returning, for pagination. |
| `payload._fields` | `string` | No | — | Comma-separated list of fields to include in the response. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Read one page of Close CRM leads (companies or organizations). Use _limit and _skip for pagination and has_more to see whether another page exists. Use _fields to request selected fields. Read-only; this does not create or update records.",
    "properties": {
      "_limit": {
        "type": "integer",
        "description": "Number of results to return.",
        "default": 100
      },
      "_skip": {
        "type": "integer",
        "description": "Number of results to skip before returning, for pagination.",
        "default": 0
      },
      "_fields": {
        "type": "string",
        "description": "Comma-separated list of fields to include in the response."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | Yes | — | — |
| `result.data.data[].addresses` | `array` | No | — | — |
| `result.data.data[].addresses[].address_1` | `string \| null` | Yes | — | — |
| `result.data.data[].addresses[].address_2` | `string \| null` | Yes | — | — |
| `result.data.data[].addresses[].city` | `string \| null` | Yes | — | — |
| `result.data.data[].addresses[].country` | `string \| null` | Yes | — | — |
| `result.data.data[].addresses[].label` | `string \| null` | Yes | — | — |
| `result.data.data[].addresses[].state` | `string \| null` | Yes | — | — |
| `result.data.data[].addresses[].tz_ids` | `array` | No | — | — |
| `result.data.data[].addresses[].zipcode` | `string \| null` | Yes | — | — |
| `result.data.data[].contact_ids` | `array` | No | — | — |
| `result.data.data[].contacts` | `array` | No | — | — |
| `result.data.data[].contacts[].created_by` | `string \| null` | No | — | — |
| `result.data.data[].contacts[].date_created` | `string` | No | — | Format: `date-time`. |
| `result.data.data[].contacts[].date_updated` | `string` | No | — | Format: `date-time`. |
| `result.data.data[].contacts[].display_name` | `string` | No | — | — |
| `result.data.data[].contacts[].emails` | `array` | No | — | — |
| `result.data.data[].contacts[].emails[].email` | `string` | Yes | — | — |
| `result.data.data[].contacts[].emails[].is_unsubscribed` | `boolean` | Yes | — | — |
| `result.data.data[].contacts[].emails[].type` | `string` | Yes | — | — |
| `result.data.data[].contacts[].id` | `string` | No | — | — |
| `result.data.data[].contacts[].integration_links` | `array` | No | — | — |
| `result.data.data[].contacts[].integration_links[].name` | `string` | Yes | — | — |
| `result.data.data[].contacts[].integration_links[].url` | `string` | Yes | — | — |
| `result.data.data[].contacts[].lead_id` | `string \| null` | No | — | — |
| `result.data.data[].contacts[].lead_suggestions_operation_id` | `string \| null` | No | — | — |
| `result.data.data[].contacts[].name` | `string \| null` | No | — | — |
| `result.data.data[].contacts[].organization_id` | `string` | No | — | — |
| `result.data.data[].contacts[].phones` | `array` | No | — | — |
| `result.data.data[].contacts[].phones[].country` | `string \| null` | No | — | — |
| `result.data.data[].contacts[].phones[].outbound_sms_blocked` | `boolean` | No | — | — |
| `result.data.data[].contacts[].phones[].phone` | `string` | Yes | — | — |
| `result.data.data[].contacts[].phones[].phone_formatted` | `string` | No | — | — |
| `result.data.data[].contacts[].phones[].type` | `string` | Yes | — | — |
| `result.data.data[].contacts[].phones[].tz_ids` | `array` | No | — | — |
| `result.data.data[].contacts[].recent_calls` | `array` | No | — | — |
| `result.data.data[].contacts[].recent_calls[].dialer_id` | `string \| null` | Yes | — | — |
| `result.data.data[].contacts[].recent_calls[].duration` | `integer` | Yes | — | — |
| `result.data.data[].contacts[].recent_calls[].finish_timestamp` | `string` | Yes | — | Format: `date-time`. |
| `result.data.data[].contacts[].recent_calls[].id` | `string` | Yes | — | — |
| `result.data.data[].contacts[].recent_calls[].status` | `"created" \| "in-progress" \| "completed" \| "cancel" \| "no-answer" \| "busy" \| "failed" \| "timeout"` | Yes | — | Current status of the call. Allowed: `created`, `in-progress`, `completed`, `cancel`, `no-answer`, `busy`, `failed`, `timeout`. |
| `result.data.data[].contacts[].subscriptions` | `array` | No | — | — |
| `result.data.data[].contacts[].subscriptions[].contact_email` | `string \| null` | Yes | — | — |
| `result.data.data[].contacts[].subscriptions[].date_created` | `string` | Yes | — | Format: `date-time`. |
| `result.data.data[].contacts[].subscriptions[].initial_email_id` | `string \| null` | Yes | — | — |
| `result.data.data[].contacts[].subscriptions[].sequence_id` | `string` | Yes | — | — |
| `result.data.data[].contacts[].subscriptions[].sequence_name` | `string` | Yes | — | — |
| `result.data.data[].contacts[].subscriptions[].sequence_status` | `"active" \| "paused" \| "draft"` | Yes | — | Allowed: `active`, `paused`, `draft`. |
| `result.data.data[].contacts[].subscriptions[].start_date` | `string \| null` | Yes | — | Format: `date-time`. |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe close_list_leads --json`.

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

* [Connect integrations](https://deepline.com/docs/integrations.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.