# Boardwalk Lists API

**Canonical:** https://apis.io/apis/boardwalkai-com/boardwalkai-com-lists-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 Lists 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 List. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Saved lists of projects, shared with you or with your team. Reading a list's configuration is free. Pulling its records uses the same record meter as search: free on County, State, and National; 1 credit per new or changed record on Standalone API Only and the free trial. Find Contact Info is billed separately when email or phone is delivered.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| GET | `/lists` | List the saved lists you can see (free) |
| POST | `/lists` | Create a named list (free) |
| POST | `/lists/{listId}/projects` | Add projects to a list (free) |
| DELETE | `/lists/{listId}/projects/{projectId}` | Remove a project from a list (free) |
| GET | `/lists/{listId}` | Read one list, and price its records (free) |
| GET | `/lists/{listId}/results` | The list's records (free) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/boardwalkai-com/openapi/boardwalkai-com-lists-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 Alerts API](https://apis.io/apis/boardwalkai-com/boardwalkai-com-alerts-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 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

List

---

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