> ## 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: Search Contacts

> ## Endpoint essentials **API key access:** `api/v1/contacts/search` or `Master API key` **OAuth scopes:** `contacts_search` **Credit usage:** `0 credits`.

## Endpoint essentials **API key access:** `api/v1/contacts/search` or `Master API key` **OAuth scopes:** `contacts_search` **Credit usage:** `0 credits`.

<Info>
  Tool ID: `apollo_search_contacts`
</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_search_contacts',
  {
    "q_keywords": "software companies hiring engineers",
    "contact_stage_ids": [
      "contact_stage_123"
    ],
    "sort_by_field": "email"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute apollo_search_contacts --input '{
  "q_keywords": "software companies hiring engineers",
  "contact_stage_ids": [
    "contact_stage_123"
  ],
  "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_search_contacts --json` for the complete live contract.

## Input reference

Search contacts in your Apollo CRM. Returns paginated results (100/page, max 500 pages). Requires master API key.

| Name                        | Type      | Required | Default | Details                                                 |
| --------------------------- | --------- | -------- | ------- | ------------------------------------------------------- |
| `payload.q_keywords`        | `string`  | No       | —       | Keywords to search across contact fields.               |
| `payload.contact_stage_ids` | `array`   | No       | —       | Filter by contact stage IDs.                            |
| `payload.sort_by_field`     | `string`  | No       | —       | Field to sort results by (e.g. "contact\_updated\_at"). |
| `payload.sort_ascending`    | `boolean` | No       | —       | Sort ascending (true) or descending (false).            |
| `payload.page`              | `integer` | No       | `1`     | Page number (max 500).                                  |
| `payload.per_page`          | `integer` | No       | `100`   | Results per page (max 100).                             |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Search contacts in your Apollo CRM. Returns paginated results (100/page, max 500 pages). Requires master API key.",
    "properties": {
      "q_keywords": {
        "type": "string",
        "description": "Keywords to search across contact fields."
      },
      "contact_stage_ids": {
        "type": "array",
        "description": "Filter by contact stage IDs.",
        "items": {
          "type": "string"
        }
      },
      "sort_by_field": {
        "type": "string",
        "description": "Field to sort results by (e.g. \"contact_updated_at\")."
      },
      "sort_ascending": {
        "type": "boolean",
        "description": "Sort ascending (true) or descending (false)."
      },
      "page": {
        "type": "integer",
        "description": "Page number (max 500).",
        "default": 1
      },
      "per_page": {
        "type": "integer",
        "description": "Results per page (max 100).",
        "default": 100
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo search contacts result.

| Name          | Type     | Required | Default | Details                                                  |
| ------------- | -------- | -------- | ------- | -------------------------------------------------------- |
| `result.data` | `record` | Yes      | —       | Payload with `contacts` 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 search contacts result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Payload with `contacts` 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)