A REST API is provided for programmatic use of the MapTargeter platform. This page summarizes the overall structure; the live OpenAPI schema and try-it console will be available from the dashboard.

Basics

• • Base URL: https://api.maptargeter.com/v1 (will be updated when production URL is published)
  • Format: Requests and responses use application/json
  • Encoding: UTF-8

  Authentication

  Send your API key in the HTTP header for all requests:

  Authorization: Bearer YOUR_API_KEY
  # or
  X-API-Key: YOUR_API_KEY

  You can create and revoke API keys from account settings. Never share keys client-side or in public repos.

  Rate limits

  Per-request and per-minute limits apply for fair use. When the limit is exceeded, a 429 Too Many Requests response and Retry-After header are returned. Limits can be increased on enterprise plans.

  Example endpoints

  Search / list

  GET /v1/leads?query=...&limit=50
  GET /v1/exports/{export_id}

  Export

  POST /v1/exports
  Content-Type: application/json
  { "format": "csv", "filters": { ... } }

  Full field list and filter operators are defined in the OpenAPI specification.

  Webhooks

  When a scan completes or an export is ready, a signed POST request can be sent to your HTTPS URL. Event types: scan.completed, export.ready, enrichment.batch_done.

  Error responses

  • • 400 — Invalid parameter or body
    • 401 — Missing or invalid API key
    • 403 — Unauthorized action or plan limit
    • 404 — Resource not found
    • 429 — Rate limit
    • 5xx — Server error; retry safely for idempotent requests

Error body format: { "error": { "code": "...", "message": "..." } }.

Versioning

Breaking changes are announced with a new major version (/v2). The previous version is supported for a period for backward compatibility.

Support

For technical integration questions, use in-dashboard support or contact your enterprise account manager.