DocumentationAPI Reference

Authentication

Authenticate MapLeads API requests with a scoped API key.

Every /v1 request is authenticated with an API key. Keep keys on a trusted server and never embed them in browser code, public repositories, query strings, or analytics payloads.

Create a key

Create and manage API keys in Settings → Developers. The full key is shown only once when it is created. Keys begin with mapleads_.

Send the key

Use a bearer token on every request:

Authorization: Bearer mapleads_xxx

The equivalent x-api-key header is also accepted:

x-api-key: mapleads_xxx

Treat API keys as secrets

The documentation playground is disabled in this PoC, so a key is never persisted by the docs site or sent to an unintended environment.

Scopes

A key can be restricted to a set of scopes. Omitting scopes leaves the key unrestricted; a scoped key missing the required permission receives 403 insufficient_scope.

ScopeAllows
readCreate and read scrape jobs and leads, then export results.
keysCreate, rename, and revoke API keys.
webhooksCreate, list, and delete webhook endpoints.
billingAccess billing control-plane operations where supported.

On this page