Getting started
Authentication
Every /v1 request is authenticated with an API key. The API never accepts a dashboard session — a browser cookie can't drive it.
Create a key
Create and manage API keys in the dashboard under Settings → Developers. The full key is shown only once, at creation — store it somewhere safe. Keys are prefixed with mapleads_.
Send the key
Pass it as a bearer token on every request:
Request header
Authorization: Bearer mapleads_xxxOr, equivalently, in an x-api-key header:
Alternative
x-api-key: mapleads_xxxScopes
A key can be restricted to a set of scopes; a scoped key may only perform those actions (omit scopes to leave it unrestricted). A request missing a required scope returns 403 insufficient_scope.
| Field | Type | Description |
|---|---|---|
| read | scope | Read scrape jobs and leads, and export results. |
| webhooks | scope | Manage webhook endpoints. |