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

# Apollo: List Deals

> ## Endpoint essentials **API key access:** `deals/api/v1/opportunities/search` or `Master API key` **OAuth scopes:** `opportunities_list` **Credit usage:** `0.

## Endpoint essentials **API key access:** `deals/api/v1/opportunities/search` or `Master API key` **OAuth scopes:** `opportunities_list` **Credit usage:** \`0.

<Info>
  Tool ID: `apollo_list_deals`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apollo_list_deals',
  {
    "page": 1,
    "per_page": 25,
    "sort_by_field": "email"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute apollo_list_deals --input '{
  "page": 1,
  "per_page": 25,
  "sort_by_field": "email"
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get apollo_list_deals --json` for the complete live contract.

## Input reference

List and search deals (opportunities) in Apollo CRM. Requires master API key.

| Name                            | Type      | Required | Default | Details                                                       |
| ------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------- |
| `payload.page`                  | `integer` | No       | `1`     | Page number.                                                  |
| `payload.per_page`              | `integer` | No       | `25`    | Results per page (max 200).                                   |
| `payload.sort_by_field`         | `string`  | No       | —       | Field name to sort by (e.g. "amount", "close\_date", "name"). |
| `payload.sort_ascending`        | `boolean` | No       | —       | Sort ascending (true) or descending (false).                  |
| `payload.opportunity_stage_ids` | `array`   | No       | —       | Filter by deal stage IDs.                                     |
| `payload.owner_ids`             | `array`   | No       | —       | Filter by deal owner user IDs.                                |
| `payload.account_ids`           | `array`   | No       | —       | Filter by associated account IDs.                             |
| `payload.q_name`                | `string`  | No       | —       | Search deals by name (partial match).                         |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "List and search deals (opportunities) in Apollo CRM. Requires master API key.",
    "properties": {
      "page": {
        "type": "integer",
        "description": "Page number.",
        "default": 1
      },
      "per_page": {
        "type": "integer",
        "description": "Results per page (max 200).",
        "default": 25
      },
      "sort_by_field": {
        "type": "string",
        "description": "Field name to sort by (e.g. \"amount\", \"close_date\", \"name\")."
      },
      "sort_ascending": {
        "type": "boolean",
        "description": "Sort ascending (true) or descending (false)."
      },
      "opportunity_stage_ids": {
        "type": "array",
        "description": "Filter by deal stage IDs.",
        "items": {
          "type": "string"
        }
      },
      "owner_ids": {
        "type": "array",
        "description": "Filter by deal owner user IDs.",
        "items": {
          "type": "string"
        }
      },
      "account_ids": {
        "type": "array",
        "description": "Filter by associated account IDs.",
        "items": {
          "type": "string"
        }
      },
      "q_name": {
        "type": "string",
        "description": "Search deals by name (partial match)."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo list deals result.

| Name          | Type     | Required | Default | Details                                                       |
| ------------- | -------- | -------- | ------- | ------------------------------------------------------------- |
| `result.data` | `record` | Yes      | —       | Payload with `opportunities` array and `pagination` metadata. |
| `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": "Apollo list deals result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Payload with `opportunities` array and `pagination` metadata.",
        "additionalProperties": {}
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

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

* [Apollo provider guide](/docs/providers/apollo/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)