canonical: https://jentic.com/apis/doorknockpro.com/door-knock-pro

# Door Knock Pro Public API

The Door Knock Pro API lets external systems read and write the records behind a door-to-door sales operation: leads, appointments, territories, users, and knock and activity history. It exposes lead statuses and property-type lookups, searches the leads inside a territory, and manages outbound webhook subscriptions with delivery inspection and replay. A company-level API key scopes every request to the company that owns it, and an optional per-user access token attributes actions to a specific rep.

## For AI agents

Read and write leads, appointments, territories, and users for a door-to-door sales team, track knock and activity history, and manage outbound webhooks. A company API key scopes every request to one company, with an optional per-user token for attributed actions.

## Scope

Does not handle payment collection, commission payouts, or route optimization. Use for managing door-to-door sales leads, appointments, and territories only.

## Capabilities

- Create, update, and soft-delete leads and read a lead's knock and activity history
- Schedule and manage appointments for field sales reps
- List territories and search the leads within a given territory
- Look up company users, teams, lead statuses, and property types
- Subscribe to outbound webhooks for lead and appointment events
- Inspect recent webhook delivery attempts and replay a failed delivery
- Authenticate a specific rep with a user access token for attributed actions

## Use cases

### Agent-driven lead capture

An AI agent connected through Jentic can turn field notes into Door Knock Pro records: create a lead from a knock, set its status, and book a follow-up appointment for the assigned rep. Each operation returns the created record so the agent can confirm the lead and appointment exist and report the appointment time back to the rep.

Example prompt: Create a lead for a newly knocked address, set its lead status, and schedule a follow-up appointment for the assigned rep.

### Territory-based lead routing

Door Knock Pro organizes leads by territory, so an agent can pull the leads within a specific territory and distribute follow-ups across the reps assigned there. Combined with the users and teams lookups, this lets a routing agent keep each rep's workload tied to their territory without exporting data to a spreadsheet.

Example prompt: Search the leads within a territory, list the users assigned to it, and report how many open leads each rep is responsible for.

### Real-time CRM sync via webhooks

Door Knock Pro emits outbound webhooks for lead and appointment events, so an external system can stay in sync without polling. An agent can register a webhook endpoint, confirm it with a synthetic ping delivery, and later replay any failed delivery so no lead update is lost during an outage.

Example prompt: Create a webhook endpoint for lead events, trigger a test ping to confirm it, and replay the most recent failed delivery.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/leads` | List leads |
| POST | `/v1/leads` | Create a lead |
| PATCH | `/v1/leads/{id}` | Update a lead |
| GET | `/v1/leads/{id}/history` | Activity history for a single lead |
| GET | `/v1/appointments` | List appointments |
| POST | `/v1/appointments` | Create an appointment |
| GET | `/v1/territories/{id}/leads` | Search leads within a territory |
| POST | `/v1/webhooks` | Create a webhook endpoint |

## Key resources

- **Leads** — Create, read, update, and soft-delete leads and read each lead's activity and knock history
- **Appointments** — Create, read, update, and soft-delete appointments for field reps
- **Territories** — List and show territories and search the leads within a given territory
- **Users & Teams** — List and show company users and reps and the teams they belong to
- **Lookups** — Read configured lead statuses and property types used across the account
- **Webhooks** — Create, update, and delete webhook endpoints, inspect deliveries, and replay failed ones

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 58 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 69 / 100
  - Developer Experience & Jentic Compatibility: 58 / 100
  - AI-Readiness & Agent Experience: 41 / 100
  - Agent Usability: 94 / 100
  - Security: 55 / 100
  - AI Discoverability: 65 / 100
- **View full report:** https://jentic.com/apis/doorknockpro.com/door-knock-pro/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Door Knock Pro by hand means managing its two-layer auth, a company X-Api-Key header on every request plus an optional per-user bearer token from the login endpoint, and coding around its per-key request limits. Through Jentic you install once, import Door Knock Pro from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Door Knock Pro puts resource ids in the URL path, for example a lead or webhook id, and its company API key makes cross-company access impossible by design. You choose the operations your agent may call, so destructive ones such as deleting a lead or rotating a webhook secret are not included unless you add them.
- **Credential handling:** Your Door Knock Pro API key, and any per-user access token, are stored encrypted by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a lead' or 'search leads in a territory', and Jentic returns the matching Door Knock Pro operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Close CRM** — Close is a full sales CRM with calling and email built in, broader than Door Knock Pro's field-sales focus
- **Pipedrive** — Pipedrive tracks deals through visual pipeline stages, where Door Knock Pro centers on leads and territories
- **Calendly** — Calendly handles public booking links that can feed appointments into Door Knock Pro
- **Svix** — Svix provides managed webhook delivery that can sit downstream of Door Knock Pro's outbound events

## FAQ

### What authentication does the Door Knock Pro API use?

The Door Knock Pro API uses a two-layer model per its OpenAPI spec: a company-level API key sent in the X-Api-Key header on every request, plus an optional per-user access token sent as a bearer token in the Authorization header and obtained from the login endpoint. The API key alone is enough for server-to-server use, while the user token attributes actions to a specific rep. Through Jentic both credentials are stored encrypted by your own Jentic One instance and injected at call time.

### Is there a Door Knock Pro MCP server?

You don't need an MCP server to give your agent the Door Knock Pro API. Jentic connects it directly from the API Directory: import Door Knock Pro, store your key once, and your agent calls its operations. Operations are discovered on demand, so no extra server's tool definitions are loaded into the agent's context.

### Can I limit what my agent is allowed to do with the Door Knock Pro API?

Yes. Write a rule that allows only the lead and appointment read and create operations, so your agent can log knocks and book visits but cannot delete leads or rotate webhook signing secrets, and every call it makes is logged. The company API key already confines all access to your own company's data, so the agent can never reach another tenant.

### Can I search leads within a territory using the Door Knock Pro API?

Yes. The territories endpoints list your configured territories and return the leads inside a specific territory, which an agent can combine with the users and teams lookups to route follow-ups to the reps assigned there. Lead and property-type lookups let the agent filter those results by status or property type.

### What are the rate limits for the Door Knock Pro API?

Door Knock Pro's spec documents 60 requests per minute per company API key and 100 requests per minute per user access token, so one user cannot exhaust the company quota. Exceeding a limit returns an HTTP 429 response; check the developer documentation for the current figures before relying on them in production.

### How do I create a lead with the Door Knock Pro API through Jentic?

Install Jentic One, import Door Knock Pro from the API Directory, and store your company API key once. Your agent then searches by intent, for example 'create a lead', and Jentic returns the matching operation with its input schema so the agent sends the right fields. To run it on your own infrastructure, install Jentic One from its GitHub repo.