Lead API · Developers
Step 1 of 5

Getting started

Find and buy leads that match your service area from your own system. Set everything up and test on Demo first.

Environments

Demo Portal demo.lead.zolar.tech API base URL https://demo.api.lead.zolar.tech
Production Portal lead.zolar.com API base URL https://api.lead.zolar.com

Demo is where you build and test. Your user and company data and your API keys stay on Demo permanently — they are not reset. The try-it console on this site sends requests to Demo only. Enter only a Demo key there (this browser keeps it in local storage); never a production key, and never put a key in code that runs in a browser or app.

Setup checklist

  1. 1

    Sign up and log in

    Create your account on lead.zolar.com. Then log in to demo.lead.zolar.tech with the same account. On Demo, finish the onboarding wizard in the portal: that makes your organisation a lead buyer straight away, with no call or approval.

  2. 2

    Configure your lead filters

    Required first

    Filters decide which leads you see: your service area, interests (solar, heat pump, battery, wallbox …), building types and project phases. The API only returns opportunities that match at least one saved filter.

    In the portal: Opportunities → New → New filter

    Filters are created and edited only in the portal; the API reads them. Keep each interest's Unknown and the building types' Other switch on unless you are sure — they match leads whose answer fits none of the options (or have no building type), and switching them off narrows your feed.

  3. 3

    Create an API key

    In the portal: Settings → API Keys

    Pick the installer permissions you need:

    • List filters (api:installer:filter:read)
    • List opportunities (api:installer:opportunity:read)
    • Buy leads (api:installer:lead:buy)
    • Read bought leads (api:installer:lead:read)
    • Update lead status (api:installer:lead:update)
    • Read webhooks (api:installer:webhook:read) and Manage webhooks (api:installer:webhook:write) — only if you will set up webhooks through the API

    Installer keys need no lead source and act for your whole organisation. The full key (sk_…) is shown once — copy it straight away.

    To rotate a key: create a new one with the same permissions, switch your system to it, then delete the old one.

  4. 4

    Check it with GET /api/public/v2/account

    Call Check your API key. The response shows the key name, its permissions, your organisation and the environment.

    curl 
    curl https://demo.api.lead.zolar.tech/api/public/v2/account \
  -H "Authorization: Bearer sk_[YOUR DEMO KEY]"
NextBuy your first lead