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

# GetLeads: Get Contacts Health

> Check whether the B2B contact database and enrichment service are up. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Check whether the B2B contact database and enrichment service are up.

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

## 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(
  'getleads_get_contacts_health',
  {},
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute getleads_get_contacts_health --input '{}' --json
```

## 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": {
    "ok": true,
    "dataset": "example",
    "aurora": {
      "status": "example",
      "detail": "example"
    }
  }
}
```

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

## Input reference

Returns health status of the contact database and enrichment upstream.

This action requires no input fields.

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns health status of the contact database and enrichment upstream.",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.ok` | `boolean` | No | — | — |
| `result.data.dataset` | `string` | No | — | — |
| `result.data.aurora` | `object` | No | — | — |
| `result.data.aurora.status` | `string` | No | — | — |
| `result.data.aurora.detail` | `string` | No | — | — |
| `result.data.enrichment_upstream` | `object` | No | — | — |
| `result.data.enrichment_upstream.ok` | `boolean` | No | — | — |
| `result.data.enrichment_upstream.variant` | `string` | No | — | — |
| `result.data.enrichment_upstream.latencyMs` | `number` | No | — | — |
| `result.data.record_count` | `integer` | No | — | — |
| `result.data.clickhouse_table` | `string` | No | — | — |
| `result.meta` | `object` | 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": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "dataset": {
            "type": "string"
          },
          "aurora": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string"
              },
              "detail": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "enrichment_upstream": {
            "type": "object",
            "properties": {
              "ok": {
                "type": "boolean"
              },
              "variant": {
                "type": "string"
              },
              "latencyMs": {
                "type": "number"
              }
            },
            "additionalProperties": false
          },
          "record_count": {
            "type": "integer"
          },
          "clickhouse_table": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "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

* [GetLeads provider guide](https://deepline.com/docs/providers/getleads/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.