> ## 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 Alerts
> Get alert data with deals. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.
Get alert data with deals.
Tool ID: `fundable_get_alerts`
## 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_alerts',
{
"alert_ids": "alert_123",
"start_date": "2026-01-15T12:00:00Z",
"end_date": "2026-01-15T12:00:00Z"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute fundable_get_alerts --input '{
"alert_ids": "alert_123",
"start_date": "2026-01-15T12:00:00Z",
"end_date": "2026-01-15T12:00:00Z"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"success": true,
"data": {},
"meta": {
"page": 123,
"page_size": 123
}
}
}
```
Use `deepline tools get fundable_get_alerts --json` for the latest machine-readable contract.
## Input reference
Retrieve saved alert data including all deals that matched the alert criteria within the specified date range. Results include a flattened array of deals sorted by date (newest first) with duplicates removed. Available on Pro+ and Enterprise plans. This endpoint does not consume credits. **Multiple Alerts Support:** - Query multiple alerts in a single request (up to 10) - Each alert returns its own flattened deals array - Different alerts can have different frequencies (e.g., one daily, one weekly) - Successful requests report `credits_used: 0`, regardless of deal count **Important Notes:** - All alert\_ids must belong to alerts you have access to - Deals are flattened from all time periods and sorted by date DESC (newest first) - Duplicate deals are automatically removed - Each deal includes AI-generated reasoning for why it matched the alert criteria - Deal structure is simplified with See the live schema below for the complete notes.
| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.alert_ids` | `string` | Yes | — | Comma-separated list of alert UUIDs (up to 10 alerts per request). All alerts must be associated with your API key's account. Example: "uuid1,uuid2,uuid3" |
| `payload.start_date` | `string` | Yes | — | Start date for the alert data range (ISO 8601 format). Results will include deals from this date onwards. Format: `date-time`. |
| `payload.end_date` | `string` | Yes | — | End date for the alert data range (ISO 8601 format). Results will include deals up to and including this date. **Note:** All dates are processed in UTC timezone. Deals are grouped into time periods based on UTC date boundaries. Format: `date-time`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Retrieve saved alert data including all deals that matched the alert criteria within the specified date range. Results include a flattened array of deals sorted by date (newest first) with duplicates removed. Available on Pro+ and Enterprise plans. This endpoint does not consume credits. **Multiple Alerts Support:** - Query multiple alerts in a single request (up to 10) - Each alert returns its own flattened deals array - Different alerts can have different frequencies (e.g., one daily, one weekly) - Successful requests report `credits_used: 0`, regardless of deal count **Important Notes:** - All alert_ids must belong to alerts you have access to - Deals are flattened from all time periods and sorted by date DESC (newest first) - Duplicate deals are automatically removed - Each deal includes AI-generated reasoning for why it matched the alert criteria - Deal structure is simplified with flattened company information for easier integration",
"properties": {
"alert_ids": {
"type": "string",
"description": "Comma-separated list of alert UUIDs (up to 10 alerts per request). All alerts must be associated with your API key's account. Example: \"uuid1,uuid2,uuid3\""
},
"start_date": {
"type": "string",
"description": "Start date for the alert data range (ISO 8601 format). Results will include deals from this date onwards.",
"format": "date-time"
},
"end_date": {
"type": "string",
"description": "End date for the alert data range (ISO 8601 format). Results will include deals up to and including this date. **Note:** All dates are processed in UTC timezone. Deals are grouped into time periods based on UTC date boundaries.",
"format": "date-time"
}
},
"required": [
"alert_ids",
"start_date",
"end_date"
],
"additionalProperties": false
}
```
## 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.alerts` | `array` | No | — | Array of alert configurations with their timeline data |
| `result.data.data.alerts[].alertId` | `string` | Yes | — | Unique identifier for the alert configuration Format: `uuid`. |
| `result.data.data.alerts[].alertName` | `string` | Yes | — | Name of the alert configuration |
| `result.data.data.alerts[].alertFrequency` | `"DAILY" \| "WEEKLY" \| "BIWEEKLY" \| "MONTHLY"` | Yes | — | Frequency setting of the alert Allowed: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`. |
| `result.data.data.alerts[].totalDealCount` | `integer` | Yes | — | Total number of deals for this alert |
| `result.data.data.alerts[].deals` | `array` | Yes | — | Array of deals that matched the alert criteria (flattened from all time periods, sorted by date DESC) |
| `result.data.data.alerts[].deals[].id` | `string` | Yes | — | Unique identifier for the deal Format: `uuid`. |
| `result.data.data.alerts[].deals[].company_id` | `string` | Yes | — | Unique identifier for the company |
| `result.data.data.alerts[].deals[].company_name` | `string \| null` | Yes | — | Company name |
| `result.data.data.alerts[].deals[].company_guru_permalink` | `string \| null` | Yes | — | Fundable permalink for the company |
| `result.data.data.alerts[].deals[].round_type` | `string \| null` | Yes | — | Type of funding round |
| `result.data.data.alerts[].deals[].date` | `string \| null` | Yes | — | Date of the funding round (ISO 8601 format) Format: `date-time`. |
| `result.data.data.alerts[].deals[].total_round_raised` | `number \| null` | Yes | — | Total amount raised in the round (USD \$M) |
| `result.data.data.alerts[].deals[].company_website` | `string \| null` | Yes | — | Company website domain |
| `result.data.data.alerts[].deals[].company_linkedin` | `string \| null` | Yes | — | Company LinkedIn URL |
| `result.data.data.alerts[].deals[].location` | `object` | Yes | — | Company location details |
| `result.data.data.alerts[].deals[].location.city` | `string \| null` | No | — | City name |
| `result.data.data.alerts[].deals[].location.state` | `string \| null` | No | — | State/province name |
| `result.data.data.alerts[].deals[].location.country` | `string \| null` | No | — | Country name |
| `result.data.data.alerts[].deals[].location.region` | `string \| null` | No | — | Geographic region name |
| `result.data.data.alerts[].deals[].deal_short_description` | `string \| null` | Yes | — | Brief description of the deal |
| `result.data.data.alerts[].deals[].deal_long_description` | `string \| null` | Yes | — | Detailed description of the deal |
| `result.data.data.alerts[].deals[].reasoning` | `string \| null` | Yes | — | AI-generated reasoning for why this deal matched the alert criteria |
| `result.data.data.alerts[].deals[].articles` | `array` | Yes | — | News articles related to this deal |
| `result.data.data.alerts[].deals[].articles[].link` | `string` | No | — | URL to the article |
| `result.data.data.alerts[].deals[].articles[].is_primary` | `boolean` | No | — | Whether this is the primary article for the deal |
| `result.data.data.alerts[].deals[].articles[].publishedDate` | `string \| null` | No | — | Article publication date (ISO 8601 format) Format: `date-time`. |
| `result.data.meta` | `object` | Yes | — | — |
| `result.data.meta.page` | `integer` | No | — | Current page number (always 0 for alerts endpoint) |
| `result.data.meta.page_size` | `integer` | No | — | Number of alerts queried in this request |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### 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": {
"alerts": {
"type": "array",
"description": "Array of alert configurations with their timeline data",
"items": {
"type": "object",
"properties": {
"alertId": {
"type": "string",
"description": "Unique identifier for the alert configuration",
"format": "uuid"
},
"alertName": {
"type": "string",
"description": "Name of the alert configuration"
},
"alertFrequency": {
"type": "string",
"description": "Frequency setting of the alert",
"enum": [
"DAILY",
"WEEKLY",
"BIWEEKLY",
"MONTHLY"
]
},
"totalDealCount": {
"type": "integer",
"description": "Total number of deals for this alert"
},
"deals": {
"type": "array",
"description": "Array of deals that matched the alert criteria (flattened from all time periods, sorted by date DESC)",
"items": {
"type": "object",
"description": "Simplified deal structure optimized for API consumption. Flattens company information and removes nested structures for easier integration. Deals are sorted by date descending (newest first) and duplicates are removed.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the deal",
"format": "uuid"
},
"company_id": {
"type": "string",
"description": "Unique identifier for the company"
},
"company_name": {
"type": [
"string",
"null"
],
"description": "Company name"
},
"company_guru_permalink": {
"type": [
"string",
"null"
],
"description": "Fundable permalink for the company"
},
"round_type": {
"type": [
"string",
"null"
],
"description": "Type of funding round"
},
"date": {
"type": [
"string",
"null"
],
"description": "Date of the funding round (ISO 8601 format)",
"format": "date-time"
},
"total_round_raised": {
"type": [
"number",
"null"
],
"description": "Total amount raised in the round (USD $M)"
},
"company_website": {
"type": [
"string",
"null"
],
"description": "Company website domain"
},
"company_linkedin": {
"type": [
"string",
"null"
],
"description": "Company LinkedIn URL"
},
"location": {
"type": "object",
"description": "Company location details",
"properties": {
"city": {
"type": [
"string",
"null"
],
"description": "City name"
},
"state": {
"type": [
"string",
"null"
],
"description": "State/province name"
},
"country": {
"type": [
"string",
"null"
],
"description": "Country name"
},
"region": {
"type": [
"string",
"null"
],
"description": "Geographic region name"
}
},
"additionalProperties": false
},
"deal_short_description": {
"type": [
"string",
"null"
],
"description": "Brief description of the deal"
},
"deal_long_description": {
"type": [
"string",
"null"
],
"description": "Detailed description of the deal"
},
"reasoning": {
"type": [
"string",
"null"
],
"description": "AI-generated reasoning for why this deal matched the alert criteria"
},
"articles": {
"type": "array",
"description": "News articles related to this deal",
"items": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "URL to the article"
},
"is_primary": {
"type": "boolean",
"description": "Whether this is the primary article for the deal"
},
"publishedDate": {
"type": [
"string",
"null"
],
"description": "Article publication date (ISO 8601 format)",
"format": "date-time"
}
},
"additionalProperties": false
}
}
},
"required": [
"id",
"company_id",
"company_name",
"company_guru_permalink",
"round_type",
"date",
"total_round_raised",
"company_website",
"company_linkedin",
"location",
"deal_short_description",
"deal_long_description",
"reasoning",
"articles"
],
"additionalProperties": false
}
}
},
"required": [
"alertId",
"alertName",
"alertFrequency",
"totalDealCount",
"deals"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page number (always 0 for alerts endpoint)"
},
"page_size": {
"type": "integer",
"description": "Number of alerts queried in this request"
}
},
"additionalProperties": false
}
},
"required": [
"success",
"data",
"meta"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## 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.