Close CRM: Close List Opportunities

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

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.

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

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.

{
  "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	—	—

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.

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.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation