Skip to main content
The LeadScout API is a REST interface that gives you programmatic access to every resource in your account. All requests and responses use JSON, all endpoints require authentication, and all mutations are scoped to your company so you can never accidentally read or write another organization’s data. Whether you are building a custom integration, syncing data with a CRM, or powering a mobile canvassing app, the same API routes handle every client.

​
Base URL

All example URLs in this reference use that base.

​
Request format

Send Content-Type: application/json with every POST and PATCH request. GET and DELETE requests never require a body.

​
Response format

Successful responses return JSON. List endpoints return a paginated envelope:
Single-resource endpoints return the object directly. Delete endpoints return { "id": <number> }.

​
HTTP status codes

​
Pagination

List endpoints that support pagination accept page (default 1) and pageSize (default 50) query parameters. The response total field tells you how many records match your filters in total.
Keep pageSize at or below 100 for best performance. The /api/prospects/export endpoint streams all matching records as a CSV file and is not paginated.

​
Authentication

Every request must carry a valid credential — either a session cookie (set automatically by the web dashboard) or a Bearer JWT token for external integrations. See the Authentication page for full details and code examples.

​
Resource groups

Prospects

Create, query, update, delete, export, and import prospect records.

Territories

Define polygon-based territories and assign them to reps.

Appointments

List appointments across all prospects, with optional date filtering.

Knocks

Retrieve the full knock history (status-change events) for your team.

Tags

Create and list the tag labels that can be applied to prospects.

Webhooks

Register outbound webhooks to receive real-time event notifications.

Users

List team members, invite new users, and manage roles and permissions.

Authentication

Understand the two supported auth mechanisms and how to obtain tokens.