> ## Documentation Index > Fetch the complete documentation index at: https://docs.getmailr.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Mailr is a direct-mail marketing platform for US home-services contractors. Each postcard is personalized with an AI-enhanced image of the recipient's own home and a unique QR code that leads to a personalized landing page. Campaigns can target a neighborhood the customer draws on a map, the homes around past jobs they upload or import, or fire automatically from their CRM. Mailr does not mail an uploaded recipient list. When answering questions, prefer the exact steps and UI labels from these docs, and direct users to app.getmailr.com to sign in. For anything involving account-specific data, billing disputes, or mail that appears lost, direct the user to support@getmailr.com. # Poll recent landing-page leads > Return this org's most recent landing-page leads, newest first, capped at 50. Optional `?since=` returns leads created strictly after that timestamp. Only `source=landing_page` leads are returned — CRM-synced leads are never polled back out. De-dupe by `id`. Setup aid: an org with no real leads yet receives exactly one clearly flagged sample lead (`test: true`, fixed all-zero `id`) so a Zap's "Test trigger" step can map fields. It disappears once a real lead exists. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/v1/integrations/leads openapi: 3.1.0 info: title: Mailr Developer API version: 1.0.0 description: > The Mailr Developer API lets a contractor's own CRM or automation stack drive Mailr directly with a per-tenant bearer key — no vendor polling, no Zapier in the middle. You push **events** when a job or deal changes, Mailr matches them against the automations you configured in the app and mails per-recipient Street View postcards; you push **won deals** and **leads** for revenue attribution; you **subscribe** an endpoint to receive captured leads back (HMAC-signed); and you **stage past jobs** for a reactivation campaign. ## Authentication Every endpoint here authenticates with an organization-scoped API key presented as `Authorization: Bearer ak_…`. The key alone identifies the tenant — you never pass an `org_id`, connection id, or batch id in the body or query; anything you could name is derived from the key. Create keys in the Mailr app under your workspace name (bottom-left) -> Manage account -> API keys (workspace Owner only). ## Scopes Keys may declare scopes. Policy (v1): if a key declares **any** scopes, it must include the scope an operation requires; a key that declares **no** scopes is treated as unrestricted and passes every check. The scopes in use are `events:write`, `import:write`, and `webhooks:inbound`. Each operation below documents its required scope under `x-required-scope`. ## Base URL Production is `https://app.getmailr.com`. All paths below are relative to it. ## Versioning The public API is versioned under `/api/v1/*` — every endpoint documented here lives under it. The Mailr Zapier app targets `/api/v1/*`; build new integrations against the same prefix. ## Idempotency Write endpoints are idempotent on a caller-supplied key: `dedup_id` on events, `deal_id`/address on conversions and leads. Imports are **not** deduplicated: one request is one batch, and duplicate addresses within or across batches are staged independently. Replaying the same request is safe and is reported back to you (e.g. `duplicate: true`, `idempotent: true`, or `reason: "duplicate"`). ## Auth-path errors (all endpoints) Besides each endpoint's own statuses, every authenticated endpoint can return two RETRYABLE auth-path errors: `429` `{ "error": "rate_limited" }` when the pre-auth per-IP limit (60/min/IP) trips, and `503` `{ "error": "auth_unavailable" }` when the auth provider is temporarily unreachable (your key was NOT checked). Both carry `Retry-After`. Neither means your key is bad — only a `401` does. ## Delivery cadence There is **no reconciliation sweep**. Mailr does not reach back into your CRM to pull anything it missed — the caller is the sync. If a push fails or you suspect a gap, **replay your events**; idempotency makes replays free. contact: name: Mailr url: https://app.getmailr.com servers: - url: https://app.getmailr.com description: Production security: - bearerAuth: [] tags: - name: Events description: Push CRM/automation events that trigger campaigns (Developer API v1). - name: Imports description: >- Stage a batch of past jobs/customers for a reactivation campaign (Developer API v1). - name: Leads description: Receive captured leads (subscribe) and poll recent leads. - name: Attribution description: >- Report won deals and synced leads so revenue attributes to the campaign that mailed the address. - name: Customers description: Register existing customers for address suppression. - name: Account description: Identify the key's organization and list its automations. paths: /api/v1/integrations/leads: get: tags: - Leads summary: Poll recent landing-page leads description: > Return this org's most recent landing-page leads, newest first, capped at 50. Optional `?since=` returns leads created strictly after that timestamp. Only `source=landing_page` leads are returned — CRM-synced leads are never polled back out. De-dupe by `id`. Setup aid: an org with no real leads yet receives exactly one clearly flagged sample lead (`test: true`, fixed all-zero `id`) so a Zap's "Test trigger" step can map fields. It disappears once a real lead exists. operationId: listLeads parameters: - name: since in: query required: false schema: type: string format: date-time description: >- Return leads with created_at strictly greater than this ISO-8601 timestamp. responses: '200': description: Newest-first leads (or one sample lead for a brand-new org). content: application/json: schema: type: object required: - leads properties: leads: type: array items: $ref: '#/components/schemas/Lead' example: leads: - id: c1d2e3f4-0000-0000-0000-000000000020 name: Dana Reyes first_name: Dana last_name: Reyes email: dana.reyes@example.com phone: '+15125550143' address: 3134 River Valley Dr city: Austin state: TX postal_code: '78701' country: United States full_address: 3134 River Valley Dr, Austin, TX 78701 campaign_id: aa11bb22-0000-0000-0000-0000000000cc campaign_name: Spring roof reactivation source: Mailr created_at: '2026-08-19T15:04:00Z' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Unauthorized '500': description: Failed to list leads. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Failed to list leads components: schemas: Lead: type: object description: >- Canonical enriched lead (same shape at the poll endpoint and the outbound webhook). Flattened `custom_` keys are added dynamically. additionalProperties: true properties: id: type: string format: uuid test: type: boolean description: Present and true only on the setup sample lead. name: type: - string - 'null' first_name: type: string last_name: type: string email: type: - string - 'null' phone: type: - string - 'null' description: Normalized E.164 when parseable. address: type: - string - 'null' description: Street line. street: type: - string - 'null' city: type: - string - 'null' state: type: string description: Two-letter state; empty string when unknown. postal_code: type: - string - 'null' country: type: string example: United States full_address: type: - string - 'null' description: Street, city, state and postal joined into one line. latitude: type: - number - 'null' longitude: type: - number - 'null' message: type: - string - 'null' campaign_id: type: - string - 'null' campaign_name: type: - string - 'null' source: type: string example: Mailr custom_fields: type: array items: type: object properties: field_id: type: string field_label: type: string type: type: string value: type: array items: type: string created_at: type: string format: date-time example: id: c1d2e3f4-0000-0000-0000-000000000020 name: Dana Reyes first_name: Dana last_name: Reyes email: dana.reyes@example.com phone: '+15125550143' address: 3134 River Valley Dr street: 3134 River Valley Dr city: Austin state: TX postal_code: '78701' country: United States full_address: 3134 River Valley Dr, Austin, TX 78701 latitude: 30.27 longitude: -97.75 message: Roof looks rough after the last storm — can you quote? campaign_id: aa11bb22-0000-0000-0000-0000000000cc campaign_name: Spring roof reactivation source: Mailr custom_fields: - field_id: issues field_label: Issues type: select value: - Missing shingles custom_issues: Missing shingles created_at: '2026-08-19T15:04:00Z' Error: type: object description: > Error body. `error` is a stable machine code; `detail` (when present) is a human-readable explanation naming the offending field. Note two families of code style coexist across the API: snake_case machine codes on the v1 and rate-limited endpoints (`invalid_payload`, `rate_limited`, `automations_disabled`) and human sentences on the legacy endpoints (`Unauthorized`, `No address found in payload`). Both are returned in the `error` field. required: - error properties: error: type: string example: invalid_payload detail: type: string example: event_type is required securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: ak_ description: 'Organization-scoped Mailr API key. Header: `Authorization: Bearer ak_…`.' ````