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

# Findymail: Get Excluded Domains

> Returns a paginated list of excluded domains for the authenticated user. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Returns a paginated list of excluded domains for the authenticated user.

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

## 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(
  'findymail_get_excluded_domains',
  {
    "query": "software companies hiring engineers",
    "list_id": 123,
    "per_page": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute findymail_get_excluded_domains --input '{
  "query": "software companies hiring engineers",
  "list_id": 123,
  "per_page": 123
}' --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": {
    "data": [
      {
        "id": 123,
        "domain": "example.com",
        "excluded_domain_list_id": 123
      }
    ],
    "current_page": 123,
    "per_page": 123
  }
}
```

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

## Input reference

Returns a paginated list of excluded domains for the authenticated user. Can be filtered by list\_id to get domains from a specific list, otherwise returns the global exclusion list.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.query` | `string` | No | — | Search query to filter domains. |
| `payload.list_id` | `integer` | No | — | Filter domains by list ID. |
| `payload.per_page` | `integer` | No | — | Number of domains per page. |
| `payload.page` | `integer` | No | — | Page number. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a paginated list of excluded domains for the authenticated user. Can be filtered by list_id to get domains from a specific list, otherwise returns the global exclusion list.",
    "properties": {
      "query": {
        "type": "string",
        "description": "Search query to filter domains."
      },
      "list_id": {
        "type": "integer",
        "description": "Filter domains by list ID."
      },
      "per_page": {
        "type": "integer",
        "description": "Number of domains per page."
      },
      "page": {
        "type": "integer",
        "description": "Page number."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].id` | `integer` | No | — | — |
| `result.data.data[].domain` | `string` | No | — | — |
| `result.data.data[].excluded_domain_list_id` | `integer` | No | — | — |
| `result.data.current_page` | `integer` | No | — | — |
| `result.data.per_page` | `integer` | No | — | — |
| `result.data.total` | `integer` | 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": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "domain": {
                  "type": "string"
                },
                "excluded_domain_list_id": {
                  "type": "integer"
                }
              },
              "additionalProperties": false
            }
          },
          "current_page": {
            "type": "integer"
          },
          "per_page": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          }
        },
        "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

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