# Boardwalk Alerts API

**Canonical:** https://apis.io/apis/boardwalkai-com/boardwalkai-com-alerts-api/  
**Provider:** Boardwalk — https://apis.io/providers/boardwalkai-com/  
**Base URL:** https://api.boardwalkai.com/api/v1  
**Documentation:** https://boardwalkai.com/docs/api/reference/

Boardwalk Alerts API is one of 11 APIs that [Boardwalk](https://apis.io/providers/boardwalkai-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Standing searches that run on a cadence and deliver into your account. Configuration and runs are free. Find Contact Info on delivered records is billed separately when email or phone is found.

## Operations (13)

| Method | Path | Summary |
|---|---|---|
| GET | `/alerts` | List the alerts you can see (free) |
| POST | `/alerts` | Create an alert (free) |
| GET | `/alerts/{alertId}` | Read one alert (free) |
| PATCH | `/alerts/{alertId}` | Update an alert (free) |
| DELETE | `/alerts/{alertId}` | Delete an alert (free) |
| POST | `/alerts/{alertId}/preview` | Price an alert before it runs (free) |
| GET | `/alerts/{alertId}/preview` | Price an alert before it runs (free, GET form) |
| POST | `/alerts/{alertId}/run` | Run an alert now (free) |
| GET | `/alerts/{alertId}/deliveries` | The alert's change feed (free) |
| GET | `/alerts/{alertId}/deliveries/{deliveryId}` | One run's metadata (free) |
| GET | `/alerts/{alertId}/matches` | The projects already on this alert (free to read) |
| POST | `/alerts/{alertId}/dismissals/{projectId}` | Stop this alert delivering a project (free) |
| DELETE | `/alerts/{alertId}/dismissals/{projectId}` | Undo a dismissal (free) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/boardwalkai-com/openapi/boardwalkai-com-alerts-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-ai-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-project-count-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-ai-search-job-status-schema.json
- **JSONSchema** — https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-credit-balance-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-csv-export-job-accepted-schema.json
- **JSONSchema** — https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-ai-search-job-cancel-schema.json

## Other Boardwalk APIs (10)

- [Boardwalk Account API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-account-api/)
- [Boardwalk Analytics API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-analytics-api/)
- [Boardwalk Documents API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-documents-api/)
- [Boardwalk Enrichment API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-enrichment-api/)
- [Boardwalk Exports API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-exports-api/)
- [Boardwalk Lists API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-lists-api/)
- [Boardwalk Locations API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-locations-api/)
- [Boardwalk Project types API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-project-types-api/)
- [Boardwalk Projects API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-projects-api/)
- [Boardwalk Reference API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-reference-api/)

## Tags

Alerts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/boardwalkai-com/boardwalkai-com-alerts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/boardwalkai-com/.