Skyware API

GET /api/v1/ping

Ověření klíče · stačí platný klíč, bez zvláštního oprávnění

Vrátí název klíče a jeho oprávnění. Hodí se k otestování spojení.

Odpověď

{
    "data": {
        "key": "Web skyware.cz",
        "scopes": [
            "leads:write"
        ],
        "version": "v1"
    }
}

POST /api/v1/leads

Založit lead (poptávku) · oprávnění leads:write

Založí lead v pipeline (zdroj „web“, bez obchodníka), zapíše zprávu do historie leadu a upozorní obchodníky. Stejná poptávka (e-mail + text) odeslaná znovu do 10 minut se nezaloží podruhé – vrátí se původní lead s "duplicate": true. Když e-mail patří kontaktu klienta, lead se k jeho firmě propojí sám. Založení spustí sekvence „Nový lead“.

Příklad volání

curl -X POST https://vase-firma.skyware.cz/api/v1/leads \
  -H 'Authorization: Bearer sw_…' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Jana Nováková",
    "email": "jana@firma.cz",
    "phone": "+420 777 123 456",
    "company": "Firma s.r.o.",
    "message": "Chtěli bychom ukázku Skyware pro 8 lidí.",
    "page": "https://skyware.cz/poptavka",
    "utm": {
        "source": "google",
        "medium": "cpc"
    }
}'

Odpověď

{
    "data": {
        "id": 42,
        "title": "Poptávka z webu – Firma s.r.o.",
        "status": "open",
        "pipeline": {
            "id": 1,
            "name": "Weby"
        },
        "stage": {
            "id": 1,
            "name": "Nový lead",
            "role": ""
        },
        "duplicate": false
    }
}

GET /api/v1/leads

Seznam leadů · oprávnění leads:read

Od nejnověji změněných.

Příklad volání

curl 'https://vase-firma.skyware.cz/api/v1/leads?limit=20&offset=0' \
  -H 'Authorization: Bearer sw_…'

Odpověď

{
    "data": [
        {
            "id": 42,
            "title": "Poptávka z webu – Firma s.r.o.",
            "status": "open",
            "value": 120000,
            "currency": "CZK",
            "…": "…"
        }
    ],
    "meta": {
        "total": 1,
        "limit": 50,
        "offset": 0
    }
}

GET /api/v1/leads/{id}

Detail leadu · oprávnění leads:read

Lead včetně kontaktu, dalšího kroku a posledních 20 záznamů historie.

Odpověď

{
    "data": {
        "id": 42,
        "title": "…",
        "contact": {
            "name": "Jana Nováková",
            "email": "jana@firma.cz",
            "phone": ""
        },
        "activity": [
            {
                "type": "note",
                "text": "…",
                "date": "2026-09-28 10:15:00"
            }
        ]
    }
}

GET /api/v1/pipelines

Typy zakázek a fáze · oprávnění pipelines:read

Typy zakázek (pipeline) s fázemi v pořadí. role: "" běžná, quote_sent, won, lost.

Odpověď

{
    "data": [
        {
            "id": 1,
            "name": "Weby",
            "stages": [
                {
                    "id": 1,
                    "name": "Nový lead",
                    "position": 1,
                    "probability": 10,
                    "role": ""
                }
            ]
        }
    ]
}

GET /api/v1/companies

Seznam firem (klientů) · oprávnění companies:read

Podle názvu.

Odpověď

{
    "data": [
        {
            "id": 5,
            "name": "Firma s.r.o.",
            "reg_no": "12345678",
            "vat_no": "CZ12345678",
            "city": "Praha",
            "…": "…"
        }
    ],
    "meta": {
        "total": 1,
        "limit": 50,
        "offset": 0
    }
}

GET /api/v1/companies/{id}

Detail firmy · oprávnění companies:read

Odpověď

{
    "data": {
        "id": 5,
        "name": "Firma s.r.o.",
        "…": "…"
    }
}

GET /api/v1/projects

Seznam projektů · oprávnění projects:read

Od nejnověji změněných, bez smazaných.

Odpověď

{
    "data": [
        {
            "id": 37,
            "title": "Nový web",
            "company": {
                "id": 5,
                "name": "Firma s.r.o."
            },
            "status": "Rozpracováno",
            "done": false,
            "deadline": "2026-10-31"
        }
    ],
    "meta": {
        "total": 1,
        "limit": 50,
        "offset": 0
    }
}

GET /api/v1/projects/{id}

Detail projektu · oprávnění projects:read

Odpověď

{
    "data": {
        "id": 37,
        "title": "Nový web",
        "…": "…"
    }
}

GET /api/v1/invoices

Seznam vydaných faktur · oprávnění invoices:read

Od nejnovějších.

Odpověď

{
    "data": [
        {
            "id": 120,
            "number": "FV2026100042",
            "type": "faktura",
            "company": {
                "id": 5,
                "name": "Firma s.r.o."
            },
            "total": 36300,
            "total_without_vat": 30000,
            "currency": "CZK",
            "due_date": "2026-10-12",
            "paid": false
        }
    ],
    "meta": {
        "total": 1,
        "limit": 50,
        "offset": 0
    }
}

GET /api/v1/invoices/{id}

Detail faktury · oprávnění invoices:read

Odpověď

{
    "data": {
        "id": 120,
        "number": "FV2026100042",
        "…": "…"
    }
}