WalkLists API Documentation

REST API for door-to-door canvassing operations — programmatic access to walk lists, contacts, field tasks, voter and consumer data enrichment, and route optimization. Authenticate with Sanctum bearer tokens; responses are JSON over HTTPS.

What the API covers

The WalkLists API exposes every primitive a campaign manager, sales operations lead, or integration partner needs to wire WalkLists into their broader stack — CRM, dialer, voter file vendor, or custom internal tooling.

• Contacts — create, read, search, and segment voter or prospect records. Supports geocoded address, contact metadata, and per-contact custom fields.
• Lists — static and dynamic contact lists. Filter by district, party, age band, support score, or any custom attribute.
• Walk Lists / Field Maps — mint route-optimized PDF walk lists or shareable digital field maps for the mobile rep app.
• Tasks & Activities — canvasser disposition write-back: log status (yes / no / not home / spoken with), notes, and survey responses against any contact.
• Data Enrichment — on-demand voter file pull, address validation and geocoding through the CSV2GEO data layer.
• Webhooks — push status changes, completed routes, and survey responses into your downstream systems in real time.

Authentication

Every API request requires a Bearer token. Generate one from /account/api-tokens (admin permission required). Tokens are scoped per-organization and can be revoked any time. Send them as Authorization: Bearer YOUR_TOKEN on every request.

Base URL & conventions

Production base: https://walklists.com/api. All endpoints accept and return JSON. Pagination follows the standard page and per_page query parameters. Errors return RFC 7807 problem-details JSON with a stable type field for programmatic handling.

Rate limits

60 requests per minute per token by default; bursts up to 120. Rate-limit headers (X-RateLimit-Remaining) ride on every response. Higher limits available on Team and Enterprise plans — contact us via the contact form.

Get started

Browse the interactive endpoint reference above (loads from openapi.yaml) once JavaScript is enabled. Or pull the OpenAPI 3.1 spec directly to scaffold a client in your language of choice.

Need help? See the WalkLists Help Center for guides, or sign up free to start canvassing today.