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

> Read Close CRM sales opportunities for a sync: list sales deals filtered by owner, lead, status or date. Includes SDK V2 examples, schemas, and cost.

Read Close CRM sales opportunities for a sync: list sales deals filtered by owner, lead, status or date.

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

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run close_list_opportunities --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": [
      {
        "annualized_expected_value": 1,
        "annualized_value": 1
      }
    ],
    "has_more": true
  }
}
```

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

## Input reference

Read one page of Close CRM opportunities (sales deals). Filter by lead, owner, status or date using the listed fields. Use \_limit and \_skip for pagination and has\_more to see whether another page exists. Monetary values are in cents. Use \_fields to request selected fields. Read-only. This does not change the sales pipeline.

| 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. |
| `payload.lead_id` | `string` | No | — | — |
| `payload.organization_id` | `string` | No | — | — |
| `payload.user_id` | `string` | No | — | — |
| `payload.user_id__in` | `string` | No | — | — |
| `payload.status_id` | `string` | No | — | — |
| `payload.status_id__in` | `string` | No | — | — |
| `payload.status_type` | `string` | No | — | — |
| `payload.status_type__in` | `string` | No | — | — |
| `payload.status_label` | `string` | No | — | — |
| `payload.status_label__in` | `string` | No | — | — |
| `payload.status` | `string` | No | — | — |
| `payload.status__in` | `string` | No | — | — |
| `payload.date_won` | `string` | No | — | — |
| `payload.date_won__gte` | `string` | No | — | — |
| `payload.date_won__gt` | `string` | No | — | — |
| `payload.date_won__lte` | `string` | No | — | — |
| `payload.date_won__lt` | `string` | No | — | — |
| `payload.date_created` | `string` | No | — | — |
| `payload.date_created__gte` | `string` | No | — | — |
| `payload.date_created__gt` | `string` | No | — | — |
| `payload.date_created__lte` | `string` | No | — | — |
| `payload.date_created__lt` | `string` | No | — | — |
| `payload.date_updated` | `string` | No | — | — |
| `payload.date_updated__gte` | `string` | No | — | — |
| `payload.date_updated__gt` | `string` | No | — | — |
| `payload.date_updated__lte` | `string` | No | — | — |
| `payload.date_updated__lt` | `string` | No | — | — |
| `payload.value_period` | `string` | No | — | — |
| `payload.value_period__in` | `string` | No | — | — |
| `payload.query` | `string` | No | — | — |
| `payload.lead_query` | `string` | No | — | — |
| `payload.lead_saved_search_id` | `string` | No | — | — |
| `payload.is_stalled` | `string` | No | — | — |
| `payload._order_by` | `string` | No | — | — |

<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 opportunities (sales deals). Filter by lead, owner, status or date using the listed fields. Use _limit and _skip for pagination and has_more to see whether another page exists. Monetary values are in cents. Use _fields to request selected fields. Read-only; this does not change the sales pipeline.",
    "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."
      },
      "lead_id": {
        "type": [
          "string",
          "null"
        ]
      },
      "organization_id": {
        "type": [
          "string",
          "null"
        ]
      },
      "user_id": {
        "type": [
          "string",
          "null"
        ]
      },
      "user_id__in": {
        "type": [
          "string",
          "null"
        ]
      },
      "status_id": {
        "type": [
          "string",
          "null"
        ]
      },
      "status_id__in": {
        "type": [
          "string",
          "null"
        ]
      },
      "status_type": {
        "type": [
          "string",
          "null"
        ]
      },
      "status_type__in": {
        "type": [
          "string",
          "null"
        ]
      },
      "status_label": {
        "type": [
          "string",
          "null"
        ]
      },
      "status_label__in": {
        "type": [
          "string",
          "null"
        ]
      },
      "status": {
        "type": [
          "string",
          "null"
        ]
      },
      "status__in": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_won": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_won__gte": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_won__gt": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_won__lte": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_won__lt": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_created": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_created__gte": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_created__gt": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_created__lte": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_created__lt": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_updated": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_updated__gte": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_updated__gt": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_updated__lte": {
        "type": [
          "string",
          "null"
        ]
      },
      "date_updated__lt": {
        "type": [
          "string",
          "null"
        ]
      },
      "value_period": {
        "type": [
          "string",
          "null"
        ]
      },
      "value_period__in": {
        "type": [
          "string",
          "null"
        ]
      },
      "query": {
        "type": [
          "string",
          "null"
        ]
      },
      "lead_query": {
        "type": [
          "string",
          "null"
        ]
      },
      "lead_saved_search_id": {
        "type": [
          "string",
          "null"
        ]
      },
      "is_stalled": {
        "type": [
          "string",
          "null"
        ]
      },
      "_order_by": {
        "type": [
          "string",
          "null"
        ]
      }
    },
    "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[].annualized_expected_value` | `integer \| null` | No | — | Annualized expected value in cents. |
| `result.data.data[].annualized_value` | `integer \| null` | No | — | Annualized value in cents. |
| `result.data.data[].attachments` | `array` | No | — | — |
| `result.data.data[].attachments[].content_type` | `string \| null` | Yes | — | — |
| `result.data.data[].attachments[].filename` | `string \| null` | Yes | — | — |
| `result.data.data[].attachments[].size` | `integer \| null` | Yes | — | — |
| `result.data.data[].attachments[].thumbnail_url` | `string \| null` | No | — | — |
| `result.data.data[].attachments[].url` | `string` | Yes | — | — |
| `result.data.data[].comment_summary` | `object \| null` | No | — | — |
| `result.data.data[].comment_summary.comment_count` | `integer` | Yes | — | — |
| `result.data.data[].comment_summary.thread_id` | `string` | Yes | — | — |
| `result.data.data[].confidence` | `integer` | No | — | — |
| `result.data.data[].contact_id` | `string \| null` | No | — | — |
| `result.data.data[].contact_name` | `string \| null` | No | — | — |
| `result.data.data[].created_by` | `string \| null` | No | — | — |
| `result.data.data[].created_by_name` | `string \| null` | No | — | — |
| `result.data.data[].date_created` | `string` | No | — | Format: `date-time`. |
| `result.data.data[].date_lost` | `string \| null` | No | — | Format: `date-time`. |
| `result.data.data[].date_updated` | `string` | No | — | Format: `date-time`. |
| `result.data.data[].date_won` | `string \| null` | No | — | Format: `date`. |
| `result.data.data[].expected_value` | `integer \| null` | No | — | Value multiplied by confidence, in cents. |
| `result.data.data[].id` | `string` | No | — | — |
| `result.data.data[].integration_links` | `array` | No | — | — |
| `result.data.data[].integration_links[].name` | `string` | Yes | — | — |
| `result.data.data[].integration_links[].url` | `string` | Yes | — | — |
| `result.data.data[].is_stalled` | `boolean` | No | — | — |
| `result.data.data[].lead_id` | `string` | No | — | — |
| `result.data.data[].lead_name` | `string \| null` | No | — | — |
| `result.data.data[].lead_primary_email` | `object \| null` | No | — | — |
| `result.data.data[].lead_primary_email.email` | `string` | Yes | — | — |
| `result.data.data[].lead_primary_email.is_unsubscribed` | `boolean` | Yes | — | — |
| `result.data.data[].lead_primary_email.type` | `string` | Yes | — | — |
| `result.data.data[].lead_primary_phone` | `array \| null` | No | — | — |
| `result.data.data[].lead_primary_phone[].country` | `string \| null` | No | — | — |
| `result.data.data[].lead_primary_phone[].outbound_sms_blocked` | `boolean` | No | — | — |
| `result.data.data[].lead_primary_phone[].phone` | `string` | Yes | — | — |
| `result.data.data[].lead_primary_phone[].phone_formatted` | `string` | No | — | — |
| `result.data.data[].lead_primary_phone[].type` | `string` | Yes | — | — |
| `result.data.data[].lead_primary_phone[].tz_ids` | `array` | No | — | — |
| `result.data.data[].note` | `string \| null` | No | — | — |
| `result.data.data[].note_html` | `string \| null` | No | — | — |
| `result.data.data[].organization_id` | `string` | No | — | — |
| `result.data.data[].pipeline_id` | `string \| null` | No | — | — |
| `result.data.data[].pipeline_name` | `string \| null` | No | — | — |
| `result.data.data[].stall_status` | `object \| null` | No | — | — |
| `result.data.data[].stall_status.communication_issue` | `"no_issue" \| "cant_get_in_touch" \| "no_communication_attempts"` | Yes | — | Allowed: `no_issue`, `cant_get_in_touch`, `no_communication_attempts`. |
| `result.data.data[].stall_status.next_action` | `object` | Yes | — | — |
| `result.data.data[].stall_status.next_action.action` | `"mark_as_lost" \| "change_status" \| "follow_up" \| "adjust_close_date" \| "ask_someone_else_to_reach_out" \| "change_communication_method"` | Yes | — | Allowed: `mark_as_lost`, `change_status`, `follow_up`, `adjust_close_date`, `ask_someone_else_to_reach_out`, `change_communication_method`. |

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