> ## Documentation Index > Fetch the complete documentation index at: https://docs.tryfundable.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Alert Configurations > Retrieve all alert configurations for the authenticated user (identified by API key). Returns configuration metadata including filters, frequency, and descriptions. **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 ## OpenAPI ````yaml openapi/openapi-alerts.yaml GET /alerts/configurations openapi: 3.0.3 info: title: Deal Alerts description: > API for accessing saved alert data with simplified deal structures. ## Authentication All API requests require authentication using an API key in the Authorization header. ## Rate Limits API usage is tracked and may be subject to monthly limits depending on your API key tier. **Deal-Based Counting:** - Each request consumes credits equal to the **total number of deals** returned across all alerts - Example: Query 2 alerts → Alert 1 returns 25 deals + Alert 2 returns 22 deals = **47 credits consumed** - Empty results (no deals found) still consume 1 credit minimum **How Credits Work:** - Credit check occurs **after** the query executes - If the request would exceed your available credits, it is **rejected with a 402 error** - No partial results are returned if credits would be exceeded - Rejected requests do not consume any credits - Per-minute rate limiting (200 req/min) returns a **429 error** **Best Practices:** - Monitor `credits_used` in the `meta` section of each response - Query smaller date ranges when approaching your credit limit - Use fewer alerts per request when nearing your cap - Check the `total_count` in the `meta` section to estimate credit consumption ## Parameter Validation This API enforces strict parameter validation: - **Required Parameters**: `alert_ids`, `start_date`, and `end_date` are required - **Unknown Parameters**: Any parameter not in the allowed list will result in a `422 UNKNOWN_PARAMETER` error - **Whitelisted Parameters Only**: Only these parameters are allowed: alert_ids, start_date, end_date - **Data Types**: - `alert_ids` must be comma-separated valid UUIDs (e.g., "uuid1,uuid2,uuid3") - Date parameters must be valid ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ) - **Business Rules**: - Maximum 10 alerts per request - Date ranges cannot exceed 1 year - Start date must be before end date - Dates cannot be in the future - All date grouping is done in UTC timezone ## Response Structure The API returns alert data with flattened deal arrays: - Each alert contains a deals array with all matching deals from the date range - Deals are sorted by date descending (newest first) - Duplicate deals are automatically removed - Each deal includes simplified company information and AI-generated reasoning - Deal counts represent the total number of unique deals for each alert ## Use Cases - Retrieve historical alert data for analysis - Export alert results for reporting - Integrate alert data into external systems - Monitor deal flow matching specific criteria over time version: 1.0.0 contact: name: Fundable API Support url: jacob@tryfundable.ai license: name: Proprietary url: https://www.tryfundable.ai/terms/privacy/ servers: - url: https://www.tryfundable.ai/api/v1 description: Production server security: - bearerAuth: [] tags: - name: alerts description: Saved alert configurations and deal data paths: /alerts/configurations: get: tags: - alerts summary: Get alert configurations for authenticated user description: > Retrieve all alert configurations for the authenticated user (identified by API key). Returns configuration metadata including filters, frequency, and descriptions. **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 operationId: getAlertConfigurations parameters: [] responses: '200': description: Successful response with alert configurations content: application/json: schema: type: object properties: success: type: boolean example: true data: type: object properties: configurations: type: array description: Array of alert configurations for this email items: $ref: '#/components/schemas/AlertConfiguration' meta: type: object properties: page: type: integer description: Current page number (always 0 for this endpoint) example: 0 page_size: type: integer description: Number of configurations returned example: 3 credits_used: type: integer description: Number of credits consumed by this request example: 0 credit_source: type: string nullable: true enum: - monthly - purchased description: >- Source of credits used (only included for non-API tier keys) example: monthly monthly_credits_remaining: type: integer nullable: true description: >- Remaining monthly credits (only included for non-API tier keys) example: 1000 purchased_credits_remaining: type: integer nullable: true description: >- Remaining purchased credits (only included for non-API tier keys) example: 500 required: - success - data - meta examples: withConfigurations: summary: User with multiple alert configurations value: success: true data: configurations: - configuration_id: 550e8400-e29b-41d4-a716-446655440000 configuration_name: AI Startups Series A frequency: WEEKLY description: Track AI and ML startups raising Series A funding filters: industries: - artificial-intelligence - machine-learning financing_types: - Series A deal_size_min: 1000000 deal_size_max: 10000000 locations: - san-francisco-bay-area - new-york-new-york investors: [] companies: [] - configuration_id: 660e8400-e29b-41d4-a716-446655440001 configuration_name: Healthcare Seed Rounds frequency: DAILY description: Daily alerts for healthcare seed funding filters: industries: - health-care super_categories: - biotechnology financing_types: - Seed deal_size_min: 500000 deal_size_max: 5000000 num_employees: - 1-10 - 11-50 investors: - id: sequoia-capital name: Sequoia Capital companies: [] - configuration_id: 770e8400-e29b-41d4-a716-446655440002 configuration_name: Fintech Tracker frequency: MONTHLY description: Monthly roundup of fintech funding activity filters: industries: - financial-services - fintech financing_types: - Series A - Series B - Series C locations: - united-states companies: - id: stripe name: Stripe - id: plaid name: Plaid meta: page: 0 page_size: 3 credits_used: 0 noConfigurations: summary: User with no configurations value: success: true data: configurations: [] meta: page: 0 page_size: 0 credits_used: 0 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthError' '429': description: Rate limit exceeded (per-minute) content: application/json: schema: $ref: '#/components/schemas/RateLimitError' headers: Retry-After: description: Number of seconds to wait before retrying schema: type: integer example: 60 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ServerError' components: schemas: AlertConfiguration: type: object description: Alert configuration metadata including filters and settings properties: configuration_id: type: string format: uuid description: Unique identifier for the alert configuration example: 550e8400-e29b-41d4-a716-446655440000 configuration_name: type: string description: User-defined name for the alert example: AI Startups Series A frequency: type: string description: How often the alert runs enum: - DAILY - WEEKLY - BIWEEKLY - MONTHLY example: WEEKLY description: type: string description: Alert description combining custom, alert, and semantic descriptions example: Track AI and ML startups raising Series A funding filters: type: object description: Alert filter criteria properties: industries: type: array items: type: string description: >- Industry permalinks to filter by. Use /industry/search to find permalinks; a value that is not an exact permalink is silently ignored. example: - artificial-intelligence - machine-learning super_categories: type: array items: type: string description: >- Super category permalinks to filter by. Use /industry/search to find permalinks; a value that is not an exact permalink is silently ignored. example: - software locations: type: array items: type: string description: >- Location permalinks to filter by. Use /location/search to find permalinks; a value that is not an exact permalink is silently ignored. example: - san-francisco-bay-area - new-york-new-york financing_types: type: array items: type: string 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). example: - Series A - Series B deal_size_min: type: number nullable: true description: Minimum deal size in USD example: 1000000 deal_size_max: type: number nullable: true description: Maximum deal size in USD example: 10000000 num_employees: type: array items: type: string description: Employee count ranges example: - 1-10 - 11-50 - 51-100 investors: type: array items: type: object properties: id: type: string description: Investor identifier name: type: string description: Investor name description: Specific investors to filter by example: - id: sequoia-capital name: Sequoia Capital companies: type: array items: type: object properties: id: type: string description: Company identifier name: type: string description: Company name description: Specific companies to filter by example: - id: stripe name: Stripe required: - configuration_id - configuration_name - frequency - description - filters AuthError: type: object properties: error: type: object properties: code: type: string enum: - AUTH_ERROR - INVALID_API_KEY - INACTIVE_API_KEY example: AUTH_ERROR message: type: string example: API key not provided details: type: object properties: help: type: string example: Please provide your API key in the Authorization header format: type: string example: Bearer vg_your_api_key_here required: - error RateLimitError: type: object properties: success: type: boolean example: false error: type: object properties: code: type: string example: RATE_LIMIT_EXCEEDED message: type: string example: Rate limit exceeded. Maximum 200 requests per minute. details: type: object properties: limit: type: integer description: Maximum requests allowed per window example: 200 window: type: string description: Rate limit window duration example: 60 seconds help: type: string example: Please reduce your request frequency and try again. required: - error ServerError: type: object properties: error: type: object properties: code: type: string example: INTERNAL_SERVER_ERROR message: type: string example: An unexpected error occurred details: type: string nullable: true description: Error details (only in development mode) required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: | API key authentication using Bearer token format. Format: `Authorization: Bearer vg_your_api_key_here` API keys follow the pattern: `vg_[12_hex_chars]_[32_base64url_chars]` ````