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

# Fundable: Get Alert Configurations

> Get alert configurations for authenticated user. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get alert configurations for authenticated user.

<Info>
  Tool ID: `fundable_get_alert_configurations`
</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(
  'fundable_get_alert_configurations',
  {},
);

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

### CLI

```bash theme={null}
deepline tools execute fundable_get_alert_configurations --input '{}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "success": true,
    "data": {
      "configurations": [
        {
          "configuration_id": "123e4567-e89b-42d3-a456-426614174000",
          "configuration_name": "Example",
          "frequency": "DAILY",
          "description": "Example description",
          "filters": {}
        }
      ]
    },
    "meta": {
      "page": 123,
      "page_size": 123
    }
  }
}
```

Use `deepline tools get fundable_get_alert_configurations --json` for the latest machine-readable contract.

## Input reference

Retrieve all alert configurations for the authenticated user (identified by API key). Returns configuration metadata including filters, frequency, and descriptions. Available on Pro+ and Enterprise plans. This endpoint does not consume credits. **Important Notes:** - This endpoint does NOT consume usage credits (actualUsageCount: 0) - Returns only configuration metadata, not deal data - Does not require any query parameters - user is identified by API key - All configurations for the authenticated user are returned (no pagination) **Authentication:** - User identity is automatically determined from the API key - No email or user\_id parameter needed **Use Cases:** - Look up what alerts are configured for the authenticated user - Retrieve alert filter settings for external integrations - Audit alert configurations programmatically

This action does not require input fields.

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieve all alert configurations for the authenticated user (identified by API key). Returns configuration metadata including filters, frequency, and descriptions. Available on Pro+ and Enterprise plans. This endpoint does not consume credits. **Important Notes:** - This endpoint does NOT consume usage credits (actualUsageCount: 0) - Returns only configuration metadata, not deal data - Does not require any query parameters - user is identified by API key - All configurations for the authenticated user are returned (no pagination) **Authentication:** - User identity is automatically determined from the API key - No email or user_id parameter needed **Use Cases:** - Look up what alerts are configured for the authenticated user - Retrieve alert filter settings for external integrations - Audit alert configurations programmatically",
    "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.success` | `boolean` | Yes | — | — |
| `result.data.data` | `object` | Yes | — | — |
| `result.data.data.configurations` | `array` | No | — | Array of alert configurations for this email |
| `result.data.data.configurations[].configuration_id` | `string` | Yes | — | Unique identifier for the alert configuration Format: `uuid`. |
| `result.data.data.configurations[].configuration_name` | `string` | Yes | — | User-defined name for the alert |
| `result.data.data.configurations[].frequency` | `"DAILY" \| "WEEKLY" \| "BIWEEKLY" \| "MONTHLY"` | Yes | — | How often the alert runs Allowed: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`. |
| `result.data.data.configurations[].description` | `string` | Yes | — | Alert description combining custom, alert, and semantic descriptions |
| `result.data.data.configurations[].filters` | `object` | Yes | — | Alert filter criteria |
| `result.data.data.configurations[].filters.industries` | `array` | No | — | Industry permalinks to filter by. Use /industry/search to find permalinks; a value that is not an exact permalink is silently ignored. |
| `result.data.data.configurations[].filters.super_categories` | `array` | No | — | Super category permalinks to filter by. Use /industry/search to find permalinks; a value that is not an exact permalink is silently ignored. |
| `result.data.data.configurations[].filters.locations` | `array` | No | — | Location permalinks to filter by. Use /location/search to find permalinks; a value that is not an exact permalink is silently ignored. |
| `result.data.data.configurations[].filters.financing_types` | `array` | No | — | Types of financing rounds to include. NOTE: the Alerts API accepts human-readable round names here (e.g. "Series A", "Seed"), which differs from /deals and /companies — those use the canonical enum (e.g. SERIES\_A, SEED). |
| `result.data.data.configurations[].filters.deal_size_min` | `number \| null` | No | — | Minimum deal size in USD |
| `result.data.data.configurations[].filters.deal_size_max` | `number \| null` | No | — | Maximum deal size in USD |
| `result.data.data.configurations[].filters.num_employees` | `array` | No | — | Employee count ranges |
| `result.data.data.configurations[].filters.investors` | `array` | No | — | Specific investors to filter by |
| `result.data.data.configurations[].filters.investors[].id` | `string` | No | — | Investor identifier |
| `result.data.data.configurations[].filters.investors[].name` | `string` | No | — | Investor name |
| `result.data.data.configurations[].filters.companies` | `array` | No | — | Specific companies to filter by |
| `result.data.data.configurations[].filters.companies[].id` | `string` | No | — | Company identifier |
| `result.data.data.configurations[].filters.companies[].name` | `string` | No | — | Company name |
| `result.data.meta` | `object` | Yes | — | — |
| `result.data.meta.page` | `integer` | No | — | Current page number (always 0 for this endpoint) |
| `result.data.meta.page_size` | `integer` | No | — | Number of configurations returned |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "properties": {
              "configurations": {
                "type": "array",
                "description": "Array of alert configurations for this email",
                "items": {
                  "type": "object",
                  "description": "Alert configuration metadata including filters and settings",
                  "properties": {
                    "configuration_id": {
                      "type": "string",
                      "description": "Unique identifier for the alert configuration",
                      "format": "uuid"
                    },
                    "configuration_name": {
                      "type": "string",
                      "description": "User-defined name for the alert"
                    },
                    "frequency": {
                      "type": "string",
                      "description": "How often the alert runs",
                      "enum": [
                        "DAILY",
                        "WEEKLY",
                        "BIWEEKLY",
                        "MONTHLY"
                      ]
                    },
                    "description": {
                      "type": "string",
                      "description": "Alert description combining custom, alert, and semantic descriptions"
                    },
                    "filters": {
                      "type": "object",
                      "description": "Alert filter criteria",
                      "properties": {
                        "industries": {
                          "type": "array",
                          "description": "Industry permalinks to filter by. Use /industry/search to find permalinks; a value that is not an exact permalink is silently ignored.",
                          "items": {
                            "type": "string"
                          }
                        },
                        "super_categories": {
                          "type": "array",
                          "description": "Super category permalinks to filter by. Use /industry/search to find permalinks; a value that is not an exact permalink is silently ignored.",
                          "items": {
                            "type": "string"
                          }
                        },
                        "locations": {
                          "type": "array",
                          "description": "Location permalinks to filter by. Use /location/search to find permalinks; a value that is not an exact permalink is silently ignored.",
                          "items": {
                            "type": "string"
                          }
                        },
                        "financing_types": {
                          "type": "array",
                          "description": "Types of financing rounds to include. NOTE: the Alerts API accepts human-readable round names here (e.g. \"Series A\", \"Seed\"), which differs from /deals and /companies — those use the canonical enum (e.g. SERIES_A, SEED).",
                          "items": {
                            "type": "string"
                          }
                        },
                        "deal_size_min": {
                          "type": [
                            "number",
                            "null"
                          ],
                          "description": "Minimum deal size in USD"
                        },
                        "deal_size_max": {
                          "type": [
                            "number",
                            "null"
                          ],
                          "description": "Maximum deal size in USD"
                        },
                        "num_employees": {
                          "type": "array",
                          "description": "Employee count ranges",
                          "items": {
                            "type": "string"
                          }
                        },
                        "investors": {
                          "type": "array",
                          "description": "Specific investors to filter by",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Investor identifier"
                              },
                              "name": {
                                "type": "string",
                                "description": "Investor name"
                              }
                            },
                            "additionalProperties": false
                          }
                        },
                        "companies": {
                          "type": "array",
                          "description": "Specific companies to filter by",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Company identifier"
                              },
                              "name": {
                                "type": "string",
                                "description": "Company name"
                              }
                            },
                            "additionalProperties": false
                          }
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "configuration_id",
                    "configuration_name",
                    "frequency",
                    "description",
                    "filters"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "meta": {
            "type": "object",
            "properties": {
              "page": {
                "type": "integer",
                "description": "Current page number (always 0 for this endpoint)"
              },
              "page_size": {
                "type": "integer",
                "description": "Number of configurations returned"
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "success",
          "data",
          "meta"
        ],
        "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

* [Fundable provider guide](/docs/providers/fundable/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)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.