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

> List the notes on an Apollo contact, account, or deal. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the notes on an Apollo contact, account, or deal.

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

## 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(
  'apollo_list_notes',
  {
    "contact_id": "contact_123",
    "account_id": "123456789",
    "opportunity_id": "opportunity_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute apollo_list_notes --input '{
  "contact_id": "contact_123",
  "account_id": "123456789",
  "opportunity_id": "opportunity_123"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe apollo_list_notes --json` for the complete live contract.

## Input reference

List notes from Apollo. At least one relation filter (contact\_id, account\_id, opportunity\_id) is required.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.contact_id` | `string` | No | — | Filter notes by contact ID. |
| `payload.account_id` | `string` | No | — | Filter notes by account ID. |
| `payload.opportunity_id` | `string` | No | — | Filter notes by opportunity/deal ID. |
| `payload.sort` | `string` | No | — | Sort order for results. |
| `payload.page` | `integer` | No | `1` | Page number. |
| `payload.per_page` | `integer` | No | `25` | Results per page (max 100). |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "List notes from Apollo. At least one relation filter (contact_id, account_id, opportunity_id) is required.",
    "properties": {
      "contact_id": {
        "type": "string",
        "description": "Filter notes by contact ID."
      },
      "account_id": {
        "type": "string",
        "description": "Filter notes by account ID."
      },
      "opportunity_id": {
        "type": "string",
        "description": "Filter notes by opportunity/deal ID."
      },
      "sort": {
        "type": "string",
        "description": "Sort order for results."
      },
      "page": {
        "type": "integer",
        "description": "Page number.",
        "default": 1
      },
      "per_page": {
        "type": "integer",
        "description": "Results per page (max 100).",
        "default": 25
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo list notes result.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `record` | Yes | — | Payload with `notes` 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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Apollo list notes result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Payload with `notes` 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](https://deepline.com/docs/providers/apollo/guide.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.