> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leadfast.vip/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Read-only REST endpoints for scripts, dashboards and agents.

The API is read-only and reuses the exact same core as the MCP server: identical data, identical access rules.

API access is available during the 14-day trial and while a paid subscription is active. It stops when an unpaid trial ends.

## Base URL

```
https://leadfast.vip/api/v1
```

## Authentication

Create an API key in the app under **Integrations → API & agents**, then send it as a bearer token:

```bash theme={null}
curl https://leadfast.vip/api/v1/matches \
  -H "Authorization: Bearer $LEADFAST_API_KEY"
```

Keys are shown once and stored hashed. Rotate or revoke them from the same screen; revoked keys fail on the next request.

## Endpoints

| Method | Path | Returns |
| - | - | - |
| `GET` | `/matches` | Recent matches (`limit`, `cursor`, `band`, `since`) |
| `GET` | `/matches/{id}` | One match with reason, Suggested Reply and delivery results |
| `GET` | `/product` | Product profile and monitoring state |
| `GET` | `/searches` | Searches currently monitoring Reddit |
| `GET` | `/monitoring` | Monitoring state, last review and destinations |

The generated reference with full schemas is in the **API Reference** tab.

## Conventions

* JSON only, UTC ISO-8601 timestamps, snake\_case fields.
* Cursor pagination: pass `next_cursor` back as `cursor`.
* 60 requests per minute per key; `429` includes `Retry-After`.
* Errors: `{ "error": { "code": "…", "message": "…" } }`.

## What the API never does

* No writes: there is no endpoint that changes LeadFast or acts on Reddit.
* No Suggested Reply publishing: the draft is data, the decision is yours.


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