Quickstart

Step 1: Get an API key

Log in to your Flixer Pro dashboard
Go to Settings > API keys
Click Create new key
Give the key a name (e.g. “Website integration”)
Select the required scopes:
- leads:read - To retrieve leads
- leads:write - To create leads
Copy the generated key (it is shown only once!)

Keep your API key secure. Never share it in public code or repositories.

Step 2: Make your first request

Test your API key by retrieving the list of leads:

curl -X GET "https://api.flixerpro.io/v1/api/leads" \
  -H "X-API-Key: your_api_key"

const response = await fetch("https://api.flixerpro.io/v1/api/leads", {
  headers: {
    "X-API-Key": "your_api_key"
  }
});
const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api.flixerpro.io/v1/api/leads",
    headers={"X-API-Key": "your_api_key"}
)
print(response.json())

You receive a JSON response with your leads:

{
  "data": [
    {
      "id": "WRK...",
      "title": "Lekkage badkamer",
      "status": "request",
      "customer": {
        "name": "Jan de Vries"
      }
    }
  ],
  "limit": 50
}

Step 3: Create a lead

Create your first lead:

curl -X POST "https://api.flixerpro.io/v1/api/leads" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "street": "Keizersgracht",
    "streetNumber": "123",
    "postalCode": "1015 CJ",
    "city": "Amsterdam",
    "customerName": "Jan de Vries",
    "email": "[email protected]",
    "phone": "+31612345678",
    "title": "Lekkage badkamer",
    "description": "Waterdruppels op het plafond"
  }'

const response = await fetch("https://api.flixerpro.io/v1/api/leads", {
  method: "POST",
  headers: {
    "X-API-Key": "your_api_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    street: "Keizersgracht",
    streetNumber: "123",
    postalCode: "1015 CJ",
    city: "Amsterdam",
    customerName: "Jan de Vries",
    email: "[email protected]",
    phone: "+31612345678",
    title: "Lekkage badkamer",
    description: "Waterdruppels op het plafond"
  })
});
const lead = await response.json();
console.log("Lead created:", lead.id);

import requests

response = requests.post(
    "https://api.flixerpro.io/v1/api/leads",
    headers={
        "X-API-Key": "your_api_key",
        "Content-Type": "application/json"
    },
    json={
        "street": "Keizersgracht",
        "streetNumber": "123",
        "postalCode": "1015 CJ",
        "city": "Amsterdam",
        "customerName": "Jan de Vries",
        "email": "[email protected]",
        "phone": "+31612345678",
        "title": "Lekkage badkamer",
        "description": "Waterdruppels op het plafond"
    }
)
print("Lead created:", response.json()["id"])

Congratulations! You have created your first lead through the API.

Next steps

Authentication

Learn more about API keys and scopes

Lead capture

Integrate lead capture into your website

Getting started

Guides

Reference

Step 1: Get an API key

Step 2: Make your first request

Step 3: Create a lead

Next steps

Authentication

Lead capture

​Step 1: Get an API key

​Step 2: Make your first request

​Step 3: Create a lead

​Next steps

Authentication

Lead capture

Step 1: Get an API key

Step 2: Make your first request

Step 3: Create a lead

Next steps