Wróć do CRM

Dokumentacja API

FluxCRM API: 1056 tras, jeden klucz

API magazynu szans FluxCRM. Wszystkie odpowiedzi to JSON z polem `ok`; blad to `{ok: false, powod}` (422 dodaje `pola` z opisem kazdego blednego pola). Uwierzytelnianie: klucz integracji z Ustawienia > Klucze API w naglowku `Authorization: Bearer <klucz>` (stary naglowek `x-fluxcrm-klucz` dziala tak samo). Klucz ma zakres (moduly), tryb odczyt albo zapis i date waznosci; poza zakresem odpowiedz to 403, bez klucza lub z cofnietym albo wygaslym 401. Zmiany zrobione kluczem zapisuja sie jak zmiany czlowieka, a autorem w audycie jest nazwa klucza. Wysylki do klientow ida wylacznie przez kolejke akceptacji w panelu: klucz nie moze jej zatwierdzac. Limity: na klucz domyslnie 60 zadan na minute i 10 000 na dobe (zmienia wlasciciel). Kazda odpowiedz niesie `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (sekundy, okno minuty) oraz `X-RateLimit-Limit-Day`, `X-RateLimit-Remaining-Day`, `X-RateLimit-Reset-Day`. Po przekroczeniu: 429 z naglowkiem `Retry-After` (sekundy).

Wszystko, co robi panel, możesz zrobić z własnego systemu przez to samo API.

Uwierzytelnianie

Każde żądanie do /api/* (poza trasami oznaczonymi bez klucza) wymaga jednego z dwóch sposobów:

Opcjonalny nagłówek x-fluxcrm-uzytkownik trafia do dziennika audytu jako autor zmiany. Wejścia z formularza i telefonu (/api/zgloszenie, /api/telefon) używają osobnego sekretu w nagłówku x-fluxcrm-sekret.

Limity

Każdy klucz ma limit zadań na minutę (domyślnie 60) i na dobę (domyślnie 10 000), który właściciel zmienia w Ustawieniach. Każda odpowiedź zawiera nagłówki X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (okno minuty, sekundy) oraz X-RateLimit-Limit-Day, X-RateLimit-Remaining-Day, X-RateLimit-Reset-Day. Po przekroczeniu serwer odpowiada kodem 429 z nagłówkiem Retry-After (sekundy do ponowienia).

Zmiany zrobione kluczem trafiają do audytu jak zmiany człowieka, a autorem jest nazwa klucza. Klucz nie zatwierdza wysyłek do klientów: kolejka akceptacji i wysyłka poczty zostają dla człowieka w panelu.

Konwencje

Szybki start

export CRM=https://crm.twojafirma.pl
export KLUCZ=...        # klucz API instancji
curl -sS "$CRM/api/zdrowie" -H "Authorization: Bearer $KLUCZ"
curl -sS "$CRM/api/leady?status=w_trakcie" -H "Authorization: Bearer $KLUCZ"

Wersja v1, wycofywanie i przykłady

Wszystkie trasy są dostępne także pod prefiksem /api/v1 (stare /api/* działają bez zmian). Odpowiedź v1 niesie nagłówki X-Fluxcrm-Api-Version i X-Fluxcrm-Api-Wycofanie; aktualną wersję, datę wycofania i politykę zwraca publiczne GET /api/v1/wersje. Interaktywna dokumentacja z przyciskiem „Try it out”: /api/v1/docs, zamrożony kontrakt: /api/v1/openapi.json.

curl -sS "$CRM/api/v1/leady?filter[etap]=oferta&sort=-utworzono&fields=id,nazwa,etap&limit=100" -H "Authorization: Bearer $KLUCZ"
curl -sS "$CRM/api/v1/leady?limit=100&cursor=$NEXT_CURSOR" -H "Authorization: Bearer $KLUCZ"
curl -sS -X POST "$CRM/api/v1/leady" -H "Authorization: Bearer $KLUCZ" -H "Idempotency-Key: $(uuidgen)" -H "Content-Type: application/json" -d '{"firma":"ACME","nazwa_kontaktu":"Jan Kowalski","email":"jan@acme.pl"}'
curl -sS "$CRM/api/v1/me" -H "Authorization: Bearer $KLUCZ"

Dokument maszynowy (OpenAPI 3.1): /api/openapi.json. Przewodniki: integracja formularza, serwer MCP dla agentów.

Agenci operacyjni

get/api/agenciAgenci: tryb, dziennik dzisiejszy, zuzycie tokenow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/agenci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agenci/akceptacjaAkceptacja szkicow agentow: bez edycji, czas do wysylki, powody odrzucen, kanaly, odpowiedzi klientow, koszt, przeglad i tryb auto per typ

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/agenci/akceptacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agenci/akceptacja_powodPowod odrzucenia szkicu AI: fakty, ton, dlugosc, nie_ten_moment, inne

Ciało (JSON)

PoleTypOpis
idinteger
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agenci/akceptacja_powod" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "powod": ...}'
post/api/agenci/akceptacja_zmianaZmiana promptu lub reguly zapisana po przegladzie szkicow (zamyka przeglad; tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
plikstring
opisstring
przeglad_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agenci/akceptacja_zmiana" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"plik": ..., "opis": ..., "przeglad_id": ...}'
get/api/agenci/dziennikDziennik dzialan agentow

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie
agentzapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agenci/dziennik" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agenci/osintAgent OSINT: wywiad i brief dla szansy (wymaga dostawcy modelu)

Ciało (JSON)

PoleTypOpis
lead_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/agenci/osint" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ...}'
post/api/agenci/po_spotkaniuAgent po spotkaniu: notatka i zadania z transkrypcji

Ciało (JSON)

PoleTypOpis
lead_idinteger
transkrypcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/agenci/po_spotkaniu" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "transkrypcja": ...}'
post/api/agenci/raport_porannyRaport poranny agenta (raz na dzien, wymus: ponownie)

Ciało (JSON)

PoleTypOpis
wymusboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/agenci/raport_poranny" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wymus": ...}'
post/api/agenci/slaAgent SLA odpowiedzi: zadania dla szans czekajacych na nas

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/agenci/sla" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agenci/spotkanieAgent przygotowujacy spotkanie z zadania z godzina

Ciało (JSON)

PoleTypOpis
zadanie_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/agenci/spotkanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zadanie_id": ...}'
post/api/agenci/ustawieniaTryb agentow: normalny, podpowiadaj, wylaczony (wylacznik awaryjny; tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
trybstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agenci/ustawienia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tryb": ...}'
get/api/agenci/zuzycieZuzycie tokenow per agent

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agenci/zuzycie" \
  -H "Authorization: Bearer $KLUCZ"

Ai

get/api/aiStan AI i licznik kosztow: dzis, miesiac, per zadanie, limity, czy wylaczone

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/ai" \
  -H "Authorization: Bearer $KLUCZ"
get/api/ai/dziennikDziennik wywolan modelu: zadanie, wersja promptu, tokeny, czas, koszt, wynik

Parametry

NazwaGdzieTypWymagany
limitzapytaniestringnie
zadaniezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/ai/dziennik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/ai/prompty/{skrot}Tresc instrukcji zapisanej w audycie promptow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/ai/prompty/<skrot>" \
  -H "Authorization: Bearer $KLUCZ"
post/api/ai/trybTryb AI instancji: wylaczona, zanonimizowane (domyslny, dane osobowe zastapione znacznikami) albo pelna (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
trybstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/ai/tryb" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tryb": ...}'
post/api/ai/wylacznikCzerwony przycisk: wylaczenie albo wlaczenie AI w instancji (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
wylaczboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/ai/wylacznik" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wylacz": ...}'

Alerty

get/api/alertyAlerty KPI: otwarte, dziennik z czasem reakcji, propozycje zmiany progu, progi z opisem domyslnych wartosci, aktualnosc importu (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/alerty" \
  -H "Authorization: Bearer $KLUCZ"
put/api/alerty/progiProgi alertow (spadek leadow, koszt leada, martwy import): wlaczony, prog, kanal powiadomienia (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
progiobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/alerty/progi" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"progi": ...}'
put/api/alerty/propozycjaDecyzja o propozycji zmiany progu po 3 zignorowanych alertach: przyjmij albo odrzuc (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
alertstring
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/alerty/propozycja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"alert": ..., "akcja": ...}'
put/api/alerty/reakcjaReakcja na alert w dzienniku: podjeto albo ignoruj, z wynikiem (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
idstring
reakcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/alerty/reakcja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "reakcja": ...}'

Analityka

get/api/analityka/aktywnoscAktywnosc zespolu na osobe (telefony, maile, wiadomosci, oferty, spotkania, zadania zamkniete, mediana odpowiedzi) za tydzien albo miesiac z porownaniem i wnioskiem

Parametry

NazwaGdzieTypWymagany
okreszapytaniestringnie
datazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/analityka/aktywnosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/arkuszSzanse jako CSV do Google Sheets (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/analityka/arkusz" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/benchmarkAnonimowy profil instancji i porownanie z profilami innych instancji

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/analityka/benchmark" \
  -H "Authorization: Bearer $KLUCZ"
put/api/analityka/benchmarkProfile innych instancji do porownania (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
profilearray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/analityka/benchmark" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"profile": ...}'
get/api/analityka/hurtowniaHurtownia danych: ZIP z CSV ukladu gwiazdy, schemat.sql i zaladuj.py (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/analityka/hurtownia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/kohortyKohorty miesieczne: leady z miesiaca i ile wygralo po 30, 60 i 90 dniach, z wnioskiem

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/analityka/kohorty" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/metrykiMetryki okresu (tydzien piatek-czwartek albo miesiac) z porownaniem do poprzedniego: nowe leady, mediana pierwszej odpowiedzi per kanal, konwersja etapow, wygrane i przychod per zrodlo

Parametry

NazwaGdzieTypWymagany
okreszapytaniestringnie
datazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/analityka/metryki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/prognozaPrognoza przychodu z otwartych szans na biezacy miesiac i kwartal: kwota i wartosc wazona prawdopodobienstwem etapu z historii (zrodlo historia/domyslne), szanse bez terminu, model per etap

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/analityka/prognoza" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/raport_tygodniowyRaport tygodniowy dla zarzadu jako PDF albo HTML (format, data); tylko wlasciciel

Parametry

NazwaGdzieTypWymagany
formatzapytaniestringnie
datazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/analityka/raport_tygodniowy" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/szansaPredykcja wygranej (%) z wyjasnieniem cech, termin zamkniecia, rekomendacja ceny i pora kontaktu jednej szansy

Parametry

NazwaGdzieTypWymagany
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/analityka/szansa" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/tvDane pulpitu TV (strona /panel/tv.html)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/analityka/tv" \
  -H "Authorization: Bearer $KLUCZ"
get/api/analityka/wydatkiWydatki na reklame wpisane w Ustawieniach (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/analityka/wydatki" \
  -H "Authorization: Bearer $KLUCZ"
put/api/analityka/wydatkiZastapienie listy wydatkow na reklame [{zrodlo, miesiac, kwota}] (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
wydatkiarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/analityka/wydatki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wydatki": ...}'

Ankieta panelu

get/api/ankieta_paneluAnkieta zadowolenia z panelu raz na kwartal: stan konta, a dla wlasciciela wyniki

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/ankieta_panelu" \
  -H "Authorization: Bearer $KLUCZ"
post/api/ankieta_paneluOdpowiedz konta na ankiete kwartalna (ocena 1-5, komentarz)

Ciało (JSON)

PoleTypOpis
ocenainteger
komentarzstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/ankieta_panelu" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ocena": ..., "komentarz": ...}'

Ankiety zespolu

get/api/ankiety_zespoluAnkiety wewnetrzne zespolu z wynikami

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/ankiety_zespolu" \
  -H "Authorization: Bearer $KLUCZ"
post/api/ankiety_zespoluNowa ankieta wewnetrzna

Ciało (JSON)

PoleTypOpis
pytaniestring
opcjearray
anonimowaboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/ankiety_zespolu" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"pytanie": ..., "opcje": ..., "anonimowa": ...}'
post/api/ankiety_zespolu/{id}/glosGlos w ankiecie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
opcjainteger
komentarzstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/ankiety_zespolu/123/glos" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"opcja": ..., "komentarz": ...}'
post/api/ankiety_zespolu/{id}/zamknijZamkniecie ankiety (autor albo wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/ankiety_zespolu/123/zamknij" \
  -H "Authorization: Bearer $KLUCZ"

Aplikacja

get/api/aplikacja/dzisWidzet Dzis: do odpowiedzi, zadania na dzis i zalegle, najblizsze spotkanie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/aplikacja/dzis" \
  -H "Authorization: Bearer $KLUCZ"
get/api/aplikacja/sklepDeklaracja danych aplikacji dla Google Play

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/aplikacja/sklep" \
  -H "Authorization: Bearer $KLUCZ"
get/api/aplikacja/skrotSkrot dla zegarka i samochodu: czekajacy klienci i zdanie do odczytu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/aplikacja/skrot" \
  -H "Authorization: Bearer $KLUCZ"
post/api/aplikacja/synchronizacjaKolejka zmian aplikacji doradcy zapisanych offline (idempotentna; typy notatka, rozmowa, zadanie, odlozenie, plik, nowy_lead)

Ciało (JSON)

PoleTypOpis
urzadzeniestring
zmianyarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/aplikacja/synchronizacja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"urzadzenie": ..., "zmiany": ...}'
post/api/aplikacja/wizytowkaSkaner wizytowek: kontakt z tekstu OCR, opcjonalnie zalozenie szansy

Ciało (JSON)

PoleTypOpis
tekststring
zapiszboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/aplikacja/wizytowka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "zapisz": ...}'

Asystent AI

get/api/asystentAsystent: pytanie w jezyku naturalnym -> odpowiedz modelu z linkami do szans (narzedzia tylko do odczytu; handlowiec widzi tylko swoje); bez pytania stan funkcji

Parametry

NazwaGdzieTypWymagany
pytaniezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/asystent" \
  -H "Authorization: Bearer $KLUCZ"

Audyt dostepnosci

get/api/audyt_dostepnosciOstatni audyt dostepnosci WCAG i termin kolejnego (raz w roku)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/audyt_dostepnosci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/audyt_dostepnosciZapis wykonanego audytu dostepnosci (wlasciciel)

Ciało (JSON)

PoleTypOpis
wynikstring
uwagistring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/audyt_dostepnosci" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wynik": ..., "uwagi": ...}'

Automat

get/api/automatAutomatyka rundy 5: kolejka zadan, okno wysylek, sekwencje, autopilot, piaskownica

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/automat" \
  -H "Authorization: Bearer $KLUCZ"
get/api/automat/autopilotAutopilot zaufanych typow wewnetrznych: dozwolone, wlaczone, zaufanie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/automat/autopilot" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automat/import/odswiezImport zdarzeniowy (push) jednego zrodla

Ciało (JSON)

PoleTypOpis
zrodlostring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/import/odswiez" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zrodlo": ...}'
get/api/automat/kolejkaKolejka zadan w tle z ponawianiem (liczby i ostatnie zadania)

Parametry

NazwaGdzieTypWymagany
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/automat/kolejka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automat/kolejkaPrzetworz kolejke albo anuluj/ponow zadanie

Ciało (JSON)

PoleTypOpis
akcjastring
idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/kolejka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "id": ...}'
post/api/automat/kolejka-fluxdeskuImport pozycji kolejki Fluxdesku do kolejki propozycji CRM

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/kolejka-fluxdesku" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automat/ocena-rozmowyOcena rozmowy handlowej (transkrypcja zapisana albo tekst)

Ciało (JSON)

PoleTypOpis
rozmowa_idinteger
tekststring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/ocena-rozmowy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rozmowa_id": ..., "tekst": ...}'
get/api/automat/pamiecFakty o kliencie zebrane przez agenta pamieci

Parametry

NazwaGdzieTypWymagany
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/automat/pamiec" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automat/pamiecOdswiezenie, dodanie albo usuniecie faktu o kliencie

Ciało (JSON)

PoleTypOpis
lead_idinteger
akcjastring
rodzajstring
faktstring
idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/pamiec" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "akcja": ..., "rodzaj": ...}'
get/api/automat/piaskownicaAgenci w piaskownicy z raportem proby

Parametry

NazwaGdzieTypWymagany
agentzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/automat/piaskownica" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automat/piaskownicaAwans agenta z piaskownicy albo odrzucenie probnych propozycji

Ciało (JSON)

PoleTypOpis
agentstring
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/piaskownica" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"agent": ..., "akcja": ...}'
post/api/automat/przebiegPelny przebieg automatyki rundy 5

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/przebieg" \
  -H "Authorization: Bearer $KLUCZ"
get/api/automat/przeglad-promptowPrzeglad promptow z ostatnich 30 dni

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/automat/przeglad-promptow" \
  -H "Authorization: Bearer $KLUCZ"
get/api/automat/sekwencjeDefinicje i uruchomione sekwencje wiadomosci

Parametry

NazwaGdzieTypWymagany
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/automat/sekwencje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automat/sekwencjeStart albo zatrzymanie sekwencji na szansie (szkice trafiaja do kolejki akceptacji)

Ciało (JSON)

PoleTypOpis
lead_idinteger
sekwencjastring
akcjastring
idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/sekwencje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "sekwencja": ..., "akcja": ...}'
get/api/automat/tonWskazowki tonu wyuczone z poprawek handlowca

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/automat/ton" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automat/umowaProjekt umowy z oferty i ustalen jako propozycja do przegladu

Ciało (JSON)

PoleTypOpis
lead_idinteger
ustaleniaarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/umowa" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "ustalenia": ...}'
post/api/automat/zdarzenieKolejkuje webhooki wychodzace dla zdarzenia szansy

Ciało (JSON)

PoleTypOpis
zdarzeniestring
lead_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/automat/zdarzenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zdarzenie": ..., "lead_id": ...}'

Automatyzacje

get/api/automatyzacjeZapier, Make, n8n: test uwierzytelnienia, lista zdarzen, zaproszenie do aplikacji Zapiera i stan katalogu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/automatyzacje" \
  -H "Authorization: Bearer $KLUCZ"
get/api/automatyzacje/arkuszeZrodla Google Sheets: eksport leadow i wygranych co godzine, import wierszy (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/automatyzacje/arkusze" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automatyzacje/arkuszeDodanie zrodla arkusza: rodzaj leady, wygrane albo import (wlasciciel)

Ciało (JSON)

PoleTypOpis
rodzajstring
arkusz_idstring
zakladkastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/automatyzacje/arkusze" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "arkusz_id": ..., "zakladka": ...}'
delete/api/automatyzacje/arkusze/{id}Usuniecie zrodla arkusza (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/automatyzacje/arkusze/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automatyzacje/arkusze/{id}/syncNatychmiastowa synchronizacja zrodla arkusza (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/automatyzacje/arkusze/123/sync" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automatyzacje/hookiREST hook: subskrypcja wyzwalacza (nowy_lead, zmiana_etapu, wygrana) bez odpytywania

Ciało (JSON)

PoleTypOpis
zdarzeniestring
urlstring

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/automatyzacje/hooki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zdarzenie": ..., "url": ...}'
get/api/automatyzacje/hooki/probkaPrzyklad dostawy dla edytora Zapa: ostatnie prawdziwe wpisy

Parametry

NazwaGdzieTypWymagany
zdarzeniezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/automatyzacje/hooki/probka" \
  -H "Authorization: Bearer $KLUCZ"
delete/api/automatyzacje/hooki/{id}Wypisanie subskrypcji REST hook

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/automatyzacje/hooki/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/automatyzacje/kanalyPowiadomienia Slack i Teams (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/automatyzacje/kanaly" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automatyzacje/kanalyDodanie kanalu Slack albo Teams: typ i adres Incoming Webhook (wlasciciel)

Ciało (JSON)

PoleTypOpis
typstring
urlstring

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/automatyzacje/kanaly" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"typ": ..., "url": ...}'
delete/api/automatyzacje/kanaly/{id}Usuniecie kanalu Slack albo Teams (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/automatyzacje/kanaly/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automatyzacje/kanaly/{id}/testWiadomosc probna na kanal Slack albo Teams (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/automatyzacje/kanaly/123/test" \
  -H "Authorization: Bearer $KLUCZ"
post/api/automatyzacje/leadUtworz lead albo zwroc istniejacego (NIP, telefon, e-mail); aktualizuj=true uzupelnia pola

Ciało (JSON)

PoleTypOpis
nazwa_kontaktustring
emailstring
telefonstring
nipstring

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/automatyzacje/lead" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa_kontaktu": ..., "email": ..., "telefon": ...}'
get/api/automatyzacje/lead/szukajZnajdz lead po telefonie (w dowolnym zapisie), e-mailu lub NIP

Parametry

NazwaGdzieTypWymagany
telefonzapytaniestringnie
emailzapytaniestringnie
nipzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/automatyzacje/lead/szukaj" \
  -H "Authorization: Bearer $KLUCZ"
get/api/automatyzacje/szablony10 gotowych Zapow z opisem i mapowaniem pol

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/automatyzacje/szablony" \
  -H "Authorization: Bearer $KLUCZ"

Bezpieczenstwo

get/api/bezpieczenstwoPolityka hasel, wymuszenie TOTP i limity zadan (pelne ustawienia tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/bezpieczenstwo" \
  -H "Authorization: Bearer $KLUCZ"
post/api/bezpieczenstwoZmiana ustawien bezpieczenstwa (wlasciciel)

Ciało (JSON)

PoleTypOpis
ustawieniaobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/bezpieczenstwo" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ustawienia": ...}'

Biblioteka maili

get/api/biblioteka_mailiBiblioteka najlepszych maili zespolu

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie
tagzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/biblioteka_maili" \
  -H "Authorization: Bearer $KLUCZ"
post/api/biblioteka_mailiDodanie maila do biblioteki (tresc albo lead_id z poczta_id)

Ciało (JSON)

PoleTypOpis
tytulstring
tematstring
trescstring
tagiarray
lead_idinteger
poczta_idinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/biblioteka_maili" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "temat": ..., "tresc": ...}'
delete/api/biblioteka_maili/{id}Usuniecie wpisu (autor albo wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X DELETE "$CRM/api/biblioteka_maili/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/biblioteka_maili/{id}/glosGlos 'przydatny' na wpis biblioteki

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
wlaczboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/biblioteka_maili/123/glos" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlacz": ...}'

Bledy

get/api/bledyBledy panelu i serwera zgrupowane (liczniki, pierwszy i ostatni raz, alert, potwierdzenie); tylko wlasciciel

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/bledy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/bledy/{id}/potwierdzPotwierdzenie przejecia grupy bledow (zatrzymuje eskalacje po godzinie); tylko wlasciciel

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/bledy/123/potwierdz" \
  -H "Authorization: Bearer $KLUCZ"

Bledy js

get/api/bledy_jsZbior bledow JS z panelu z licznikami (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/bledy_js" \
  -H "Authorization: Bearer $KLUCZ"
post/api/bledy_jsBlad JS z panelu (limit 30 na minute na IP, dedup po odcisku)

Ciało (JSON)

PoleTypOpis
komunikatstring
zrodlostring
liniainteger
sladstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/bledy_js" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"komunikat": ..., "zrodlo": ..., "linia": ...}'

Bledy serwera

get/api/bledy_serweraBledy 5xx z identyfikatorem (wlasciciel); parametr id zwraca jeden ze sladem

Parametry

NazwaGdzieTypWymagany
idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/bledy_serwera" \
  -H "Authorization: Bearer $KLUCZ"

Branża agencyjna

post/api/agencja/alokacjeAlokacja osoby do projektu w kalendarzu dostepnosci (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
loginstring
odstring
dostring
godziny_dziennumber

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/alokacje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "od": ..., "do": ...}'
delete/api/agencja/alokacje/{id}Usuniecie alokacji (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/agencja/alokacje/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/dostepnoscKalendarz dostepnosci zespolu i najblizszy termin na godziny

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie
godzinyzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/dostepnosc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/firmy/{id}/stanReczny stan firmy kampanii (szkic, odpowiedziala, odrzucona)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
stanstring
szkicstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/firmy/123/stan" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"stan": ..., "szkic": ...}'
post/api/agencja/firmy/{id}/wywiadWywiad i szkic dla jednej firmy kampanii

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/agencja/firmy/123/wywiad" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/kampanieKampanie OSINT i statystyki segmentow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/agencja/kampanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/kampanieNowa kampania OSINT z lista firm i szablonem (bez wysylki)

Ciało (JSON)

PoleTypOpis
nazwastring
segmentstring
szablonstring
firmyarray

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/kampanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "segment": ..., "szablon": ...}'
get/api/agencja/kampanie/{id}Kampania OSINT z firmami i szkicami

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/agencja/kampanie/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/kampanie/{id}/przebiegWywiad i szkice dla kolejnych firm kampanii

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
limitinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/kampanie/123/przebieg" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"limit": ...}'
get/api/agencja/konkurencjaCeny, terminy i skutecznosc per portal z ogloszen

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/konkurencja" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marzaMarza per projekt i per usluga

Parametry

NazwaGdzieTypWymagany
archiwumzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/agencja/marza" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/abonamentyMarza abonamentow: przychod miesieczny minus godziny serwisu

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/abonamenty" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/alertyAlert wczesnej straty: godziny ponad prog budzetu przy slabym postepie

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/alerty" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/kanalyMarza i zysk per kanal pozyskania (marza wygranych minus wydatki na kanal)

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/kanaly" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/klienciMarza per klient (projekty i abonamenty), klienci ponizej progu

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/klienci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/pieniadzeStrona pieniadze raportu: przychod, koszty, marza, zaleglosci

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/pieniadze" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/podwykonawcyRozliczenie podwykonawcow z terminem i statusem platnosci

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie
projekt_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/podwykonawcy" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/posrednikMarza wdrozenia dla posrednika kredytowego, prowizje partnerow, okres zwrotu

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie
cenazapytaniestringnie
godzinyzapytaniestringnie
narzedzia_mieszapytaniestringnie
okres_mieszapytaniestringnie
miesiaczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/posrednik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/stawkiStawki kosztowe godziny per osoba (od daty)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/stawki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/marza/stawkiStawka kosztowa godziny osoby od daty, nie wstecz (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
osobastring
stawkanumber

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/marza/stawki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"osoba": ..., "stawka": ...}'
get/api/agencja/marza/uslugiMarza per usluge katalogu i dwie najmniej rentowne

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/uslugi" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/marza/wycenyOferta kontra faktyczny koszt zakonczonych projektow i podpowiedz dla wycen

Parametry

NazwaGdzieTypWymagany
dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/marza/wyceny" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/podwykonawcyLista podwykonawcow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/agencja/podwykonawcy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/podwykonawcyNowy podwykonawca (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
nazwastring
stawka_godzinowanumber

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/podwykonawcy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "stawka_godzinowa": ...}'
put/api/agencja/podwykonawcy/{id}Zmiana podwykonawcy (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
aktywnyboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/agencja/podwykonawcy/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "aktywny": ...}'
delete/api/agencja/podwykonawcy/{id}Usuniecie podwykonawcy (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/agencja/podwykonawcy/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/podwykonawcy/{id}/rozliczRozliczenie kosztow podwykonawcy w miesiacu (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
miesiacstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/podwykonawcy/123/rozlicz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miesiac": ...}'
get/api/agencja/portfolioPortfolio i referencje firmy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/agencja/portfolio" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/portfolioNowy wpis portfolio (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
tytulstring
tagiarray
referencjastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/agencja/portfolio" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "tagi": ..., "referencja": ...}'
put/api/agencja/portfolio/{id}Zmiana wpisu portfolio (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tytulstring
aktywnyboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/agencja/portfolio/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "aktywny": ...}'
delete/api/agencja/portfolio/{id}Usuniecie wpisu portfolio (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/agencja/portfolio/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/prognozaPrognoza przychodu z pipeline, rat i abonamentow

Parametry

NazwaGdzieTypWymagany
miesiecyzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/prognoza" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/rozliczeniaKoszty podwykonawcow z projektow per osoba

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/rozliczenia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/scoringRanking szans ze strony wg punktow z audytu

Parametry

NazwaGdzieTypWymagany
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/scoring" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/serwisAbonamenty utrzymaniowe (MRR) i zgloszenia z SLA

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/agencja/serwis" \
  -H "Authorization: Bearer $KLUCZ"
get/api/agencja/zasobyWygasajace zasoby wszystkich klientow

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/agencja/zasoby" \
  -H "Authorization: Bearer $KLUCZ"
post/api/agencja/zasoby/przypomnieniaZadania o wygasajacych domenach i hostingu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/agencja/zasoby/przypomnienia" \
  -H "Authorization: Bearer $KLUCZ"

Centrala

get/api/centralaTelefonia w chmurze: dostawca, numery, doradcy na dyzurze, kolejka

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/centrala" \
  -H "Authorization: Bearer $KLUCZ"
get/api/centrala/kolejkaKolejka polaczen i czasy oczekiwania

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/centrala/kolejka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/centrala/kolejkaDopisanie dzwoniacego do kolejki

Ciało (JSON)

PoleTypOpis
numerstring
idstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/centrala/kolejka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"numer": ..., "id": ...}'
post/api/centrala/kolejka/{id}Odebranie albo porzucenie wpisu kolejki

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/centrala/kolejka/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'
get/api/centrala/numerNumer prezentowany klientowi wg produktu albo zrodla

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie
produktzapytaniestringnie
zrodlozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/centrala/numer" \
  -H "Authorization: Bearer $KLUCZ"
post/api/centrala/podpowiedziPodpowiedzi skryptu na zywo z fragmentu rozmowy

Ciało (JSON)

PoleTypOpis
tekststring
lead_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/centrala/podpowiedzi" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "lead_id": ...}'
get/api/centrala/skryptySkrypt rozmow: obiekcje i podpowiedzi

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/centrala/skrypty" \
  -H "Authorization: Bearer $KLUCZ"
get/api/centrala/softphoneKonfiguracja softphone WebRTC konta (SIP, token Twilio)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/centrala/softphone" \
  -H "Authorization: Bearer $KLUCZ"
post/api/centrala/softphone/startProba polaczenia z softphone i numer prezentowany

Ciało (JSON)

PoleTypOpis
lead_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/centrala/softphone/start" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ...}'
get/api/centrala/szkolenieNagrania szkoleniowe bez danych klienta

Parametry

NazwaGdzieTypWymagany
kategoriazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/centrala/szkolenie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/centrala/szkolenieOznaczenie nagrania do szkolenia (wlasciciel)

Ciało (JSON)

PoleTypOpis
rozmowa_idinteger
kategoriastring
ocenainteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/centrala/szkolenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rozmowa_id": ..., "kategoria": ..., "ocena": ...}'
get/api/centrala/trasaKolejnosc doradcow dla dzwoniacego (opiekun, dyzur)

Parametry

NazwaGdzieTypWymagany
numerzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/centrala/trasa" \
  -H "Authorization: Bearer $KLUCZ"
post/api/centrala/wejscie/ivrbez kluczaWebhook glosowy Twilio: IVR, trasowanie do doradcow, poczta (TwiML)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/centrala/wejscie/ivr"
post/api/centrala/wejscie/zdarzenie/{dostawca}bez kluczaWebhook dostawcy telefonii: koniec polaczenia (sekret albo podpis Twilio)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/centrala/wejscie/zdarzenie/<dostawca>"

Demo publiczne

get/api/demo_publiczne/stanbez kluczaStan publicznego dema bez rejestracji: wolne uruchomienia w miesiacu i minuty do resetu bazy

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X GET "$CRM/api/demo_publiczne/stan"
post/api/demo_publiczne/startbez kluczaUruchamia scenariusz demo 10 minut w bazie demo (limit miesieczny, reset co godzine)

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/demo_publiczne/start"

Diagnostyka

get/api/diagnostykaCo nie dziala i dlaczego: sprawdzenia z rada (wlasciciel); siec=1 sprawdza serwery poczty

Parametry

NazwaGdzieTypWymagany
sieczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/diagnostyka" \
  -H "Authorization: Bearer $KLUCZ"

Dokumentacja

get/api/docsbez kluczaDokumentacja API jako strona HTML generowana z tego dokumentu

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X GET "$CRM/api/docs"

Dosprzedaz

get/api/dosprzedazPropozycje uslug dodatkowych i ich skutecznosc (wygrane z zaproponowanych) per regula

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/dosprzedaz" \
  -H "Authorization: Bearer $KLUCZ"
post/api/dosprzedaz/uruchomPrzeglad klientow: nowe propozycje SEO i integracji jako zadania i szkice maili w kolejce

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/dosprzedaz/uruchom" \
  -H "Authorization: Bearer $KLUCZ"

Duplikaty

get/api/duplikaty/kandydaciKandydaci do scalenia: ta sama osoba w roznych kanalach, z pewnoscia i powodem (nic nie scala)

Parametry

NazwaGdzieTypWymagany
minzapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/duplikaty/kandydaci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/duplikaty/odrzucTo nie ta sama osoba: para znika z kart i listy kandydatow

Ciało (JSON)

PoleTypOpis
ainteger
binteger

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/duplikaty/odrzuc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"a": ..., "b": ...}'
get/api/duplikaty/podgladPodglad scalenia dwoch szans (a, b): liczby wiadomosci, zadan, notatek i zdarzen, ktora zostaje i wynik po scaleniu (nic nie scala)

Parametry

NazwaGdzieTypWymagany
azapytaniestringnie
bzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/duplikaty/podglad" \
  -H "Authorization: Bearer $KLUCZ"
get/api/duplikaty/rozmyteDuplikaty rozmyte: podobne nazwy, telefony w innym zapisie, literowki w e-mailu (poza parami znanymi)

Parametry

NazwaGdzieTypWymagany
progzapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/duplikaty/rozmyte" \
  -H "Authorization: Bearer $KLUCZ"
get/api/duplikaty/scaloneScalenia w szanse (lead) z ostatnich 7 dni, ktore mozna cofnac przez POST /api/leady/{id}/cofnij_scal

Parametry

NazwaGdzieTypWymagany
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/duplikaty/scalone" \
  -H "Authorization: Bearer $KLUCZ"

Dziennik admin

get/api/dziennik_adminDziennik zdarzen administracyjnych: zmiany rol, kluczy, kanalow, bezpieczenstwa, sesji (niezmienialny, wlasciciel)

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie
ktozapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/dziennik_admin" \
  -H "Authorization: Bearer $KLUCZ"
get/api/dziennik_admin/eksportEksport calego dziennika administracyjnego dla klienta (json albo csv w polu tresc)

Parametry

NazwaGdzieTypWymagany
formatzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/dziennik_admin/eksport" \
  -H "Authorization: Bearer $KLUCZ"
get/api/dziennik_admin/weryfikacjaKontrola lancucha skrotow dziennika administracyjnego

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/dziennik_admin/weryfikacja" \
  -H "Authorization: Bearer $KLUCZ"

Dzwonek-play

get/api/dzwonek-play/statusStan wdrozenia Dzwonka w Google Play: punkty, odsetek awarii, migracja telefonow, wydania

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/dzwonek-play/status" \
  -H "Authorization: Bearer $KLUCZ"

Dzwonki i aplikacja doradcy

get/api/dzwonkiOstatnie dzwonki do doradcow i kolejnosc doradcow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/dzwonki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/dzwonkiReczny dzwonek dla szansy z numerem

Ciało (JSON)

PoleTypOpis
lead_idinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/dzwonki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ...}'
get/api/dzwonki/czekamDzwonek dla zalogowanego doradcy (long-poll przez czekaj s)

Parametry

NazwaGdzieTypWymagany
pozapytaniestringnie
czekajzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/dzwonki/czekam" \
  -H "Authorization: Bearer $KLUCZ"
get/api/dzwonki/dyzurCzy zalogowany doradca ma wlaczony dyzur

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/dzwonki/dyzur" \
  -H "Authorization: Bearer $KLUCZ"
post/api/dzwonki/dyzurWlaczenie albo wylaczenie dyzuru doradcy

Ciało (JSON)

PoleTypOpis
wlaczonyboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/dzwonki/dyzur" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlaczony": ...}'
get/api/dzwonki/przyjeciePomiar przyjecia dzwonka (mediana, cel 20 s) i opoznienia dzwonka (cel 10 s)

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/dzwonki/przyjecie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/dzwonki/{id}/odrzucPrzekazanie dzwonka nastepnemu doradcy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/dzwonki/123/odrzuc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/dzwonki/{id}/przyjmijPrzyjecie klienta: opiekun i numer telefonu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/dzwonki/123/przyjmij" \
  -H "Authorization: Bearer $KLUCZ"
get/api/push/kluczPubliczny klucz VAPID instancji (applicationServerKey dla PushManager.subscribe)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/push/klucz" \
  -H "Authorization: Bearer $KLUCZ"
get/api/push/subskrypcjaUrzadzenia zalogowanego konta z wlaczonymi powiadomieniami

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/push/subskrypcja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/push/subskrypcjaZapis urzadzenia (PushSubscription i adres strony dzwonka) dla zalogowanego konta

Ciało (JSON)

PoleTypOpis
endpointstring
keysobject
adresstring
urzadzeniestring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/push/subskrypcja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"endpoint": ..., "keys": ..., "adres": ...}'
delete/api/push/subskrypcjaUsuniecie urzadzenia zalogowanego konta

Ciało (JSON)

PoleTypOpis
endpointstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X DELETE "$CRM/api/push/subskrypcja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"endpoint": ...}'
post/api/push/szkicAkceptacja szkicu z powiadomienia push jednorazowym tokenem (sesja konta; wynik zaakceptowano, zaplanowano albo otworz)

Ciało (JSON)

PoleTypOpis
tokenstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/push/szkic" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"token": ...}'
get/api/push/szkic/{id}Szkic agenta pierwszej odpowiedzi czekajacy na decyzje dla szansy (pasek na gorze karty)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/push/szkic/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/push/szkic/{kolejka}/{id}Akceptacja szkicu z paska karty ta sama sciezka co z powiadomienia (potwierdz: true przy szkicu nieaktualnym)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
potwierdzboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/push/szkic/<kolejka>/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"potwierdz": ...}'
post/api/push/testProbny dzwonek push na urzadzenia zalogowanego konta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 409 Konflikt
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/push/test" \
  -H "Authorization: Bearer $KLUCZ"
get/api/sms/dlrbez kluczaCallback bramki SMS ze statusem doręczenia (sekret w adresie)

Parametry

NazwaGdzieTypWymagany
sekretzapytaniestringnie
MsgIdzapytaniestringnie
statuszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/sms/dlr"
get/api/sms/do_wyslaniaSMS-y czekajace na telefon zalogowanego doradcy (aplikacja FluxCRM Dzwonek; wymaga sesji konta)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/sms/do_wyslania" \
  -H "Authorization: Bearer $KLUCZ"
get/api/sms/k/{kod}bez kluczaPrzekierowanie linku z SMS-a z licznikiem kliknięć

Odpowiedzi

  • 302 Found
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/sms/k/<kod>"
get/api/sms/kampanieLista kampanii SMS (właściciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/sms/kampanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/sms/kampanieNowa kampania SMS z listy szans: zgody, STOP, deduplikacja (właściciel)

Ciało (JSON)

PoleTypOpis
nazwastring
trescstring
lead_idsarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sms/kampanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "tresc": ..., "lead_ids": ...}'
post/api/sms/kampanie/{id}/wyslijWysyłka kampanii SMS przez kolejkę akceptacji (właściciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/sms/kampanie/123/wyslij" \
  -H "Authorization: Bearer $KLUCZ"
get/api/sms/kosztyKoszt SMS-ów wg dnia, szansy i typu

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/sms/koszty" \
  -H "Authorization: Bearer $KLUCZ"
get/api/sms/nadawcaNazwa nadawcy SMS, jej poprawność i ostatni test odbioru

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/sms/nadawca" \
  -H "Authorization: Bearer $KLUCZ"
post/api/sms/nadawca/testSMS testowy nazwy nadawcy w kolejce akceptacji (właściciel)

Ciało (JSON)

PoleTypOpis
lead_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sms/nadawca/test" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ...}'
post/api/sms/nadawca/test/{id}/odbiorWynik testu odbioru nazwy nadawcy (właściciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
odebranoboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sms/nadawca/test/123/odbior" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"odebrano": ...}'
get/api/sms/nieobecnosciNieobecności z przypomnieniem SMS i bez niego (cel -20%)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/sms/nieobecnosci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/sms/podgladDługość, liczba segmentów i kodowanie treści SMS

Parametry

NazwaGdzieTypWymagany
tresczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/sms/podglad" \
  -H "Authorization: Bearer $KLUCZ"
get/api/sms/porownaniePorównanie wysyłki SMS z telefonu doradcy i przez bramkę: koszt, ryzyko blokady numeru

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/sms/porownanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/sms/statusy/odswiezOdświeżenie statusu doręczenia z bramki (właściciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/sms/statusy/odswiez" \
  -H "Authorization: Bearer $KLUCZ"
post/api/sms/terminy/{id}/obecnoscOznaczenie obecności klienta na terminie (tak albo nie)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
obecnoscstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sms/terminy/123/obecnosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"obecnosc": ...}'
post/api/sms/{id}/wynikWynik wysylki SMS z telefonu doradcy: ok, blad; stan wyslana albo blad i zdarzenie sms kto=my

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
okboolean
bladstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sms/123/wynik" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ok": ..., "blad": ...}'

Eksport i import

get/api/eksportEksport calosci danych CRM: format json (szanse z polami K2, zdarzeniami, notatkami, zadaniami, osobami, organizacjami, wnioskami, dokumentami i zgodami) albo zip (wszystkie tabele biznesowe jako CSV i JSON, pliki i historia, bez sekretow); tylko klucz pelny albo wlasciciel, wpis w audycie

Parametry

NazwaGdzieTypWymagany
formatzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/eksport" \
  -H "Authorization: Bearer $KLUCZ"
post/api/import/crmKreator importu z Pipedrive, HubSpot i Zoho CRM (pliki CSV/xlsx base64 albo zrodlo_api z tokenem): podglad (domyslnie, nic nie zapisuje; liczby, mapowanie kolumn, etapow i wlascicieli, duplikaty po mailu i telefonie, bledy) albo zapis jako jedna partia z cofaniem; token nie jest zapisywany; tylko wlasciciel

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/import/crm" \
  -H "Authorization: Bearer $KLUCZ"
post/api/import/csvImport kontaktow z CSV jako recznych szans

Parametry

NazwaGdzieTypWymagany
podgladzapytaniestringnie

Ciało (JSON)

PoleTypOpis
csv_base64string
mapowanieobject
naglowekboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 413 Content Too Large
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/import/csv" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"csv_base64": ..., "mapowanie": ..., "naglowek": ...}'
post/api/import/csv/podgladNaglowki, 5 wierszy i propozycja mapowania CSV

Ciało (JSON)

PoleTypOpis
csv_base64string

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/import/csv/podglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"csv_base64": ...}'

Etapy

get/api/etapyEtapy lejka instancji (klucz, tytul, rola)

Zakres klucza: moduł szanse, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/etapy" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "etapy": [
    {
      "klucz": "nowe",
      "tytul": "Nowe",
      "rola": "nowe"
    },
    {
      "klucz": "w_rozmowie",
      "tytul": "W rozmowie",
      "rola": "rozmowa"
    }
  ]
}

Facebook

get/api/facebook/kolejkaSzkice komentarzy i wiadomosci do autorow postow w grupach Facebooka, stan blokady konta i limit dzienny

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/facebook/kolejka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/facebook/kolejka/{id}Akceptacja, odrzucenie albo ponowienie pozycji kolejki Facebooka (tylko sesja konta); wysylka przez fluxcrm facebook-grupy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/facebook/kolejka/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "tresc": ...}'

Film

get/api/film/statystykiMiara ukonczenia filmu wdrozeniowego: rozpoczete i ukonczone ogladania, cel powyzej 50 procent

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/film/statystyki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/film/zdarzenieZdarzenie ogladania filmu wdrozeniowego (start, 25, 50, 75, koniec)

Ciało (JSON)

PoleTypOpis
filmstring
zdarzeniestring
zrodlostring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/film/zdarzenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"film": ..., "zdarzenie": ..., "zrodlo": ...}'

Firmy

get/api/organizacjeLista firm

Zakres klucza: moduł szanse, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/organizacje" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "ile": 1,
  "organizacje": [
    {
      "id": 2,
      "nazwa": "ACME Sp. z o.o.",
      "nip": "5260250274",
      "kraj": "PL",
      "miasto": "Warszawa"
    }
  ]
}
post/api/organizacjeNowa firma (NIP znanej firmy zwraca te firme)

Zakres klucza: moduł szanse, tryb zapis.

Ciało (JSON)

PoleTypOpis
nazwastring
nipstringNIP znanej firmy zwraca te firme zamiast duplikatu
regonstring
krsstring
ulicastring
kodstring
miastostring
email_fakturystring
wwwstring
telefonstring
notatkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/organizacje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": "ACME Sp. z o.o.", "nip": "5260250274"}'

Przykładowa odpowiedź

{
  "ok": true,
  "nowa": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
get/api/organizacje/propozycjePropozycje scalenia podobnych firm

Zakres klucza: moduł szanse, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/organizacje/propozycje" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "propozycje": []
}
get/api/organizacje/z_nipPodglad: leady z tym samym NIP do jednej firmy

Zakres klucza: moduł szanse, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/organizacje/z_nip" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "grupy": []
}
post/api/organizacje/z_nipLaczenie leadow z tym samym NIP w jedna firme

Zakres klucza: moduł szanse, tryb zapis.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/organizacje/z_nip" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "grupy": []
}
get/api/organizacje/{id}Firma z osobami i szansami (id firmy)

Zakres klucza: moduł szanse, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/organizacje/123" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
put/api/organizacje/{id}Czesciowa edycja firmy (id firmy)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
nipstringNIP znanej firmy zwraca te firme zamiast duplikatu
regonstring
krsstring
ulicastring
kodstring
miastostring
email_fakturystring
wwwstring
telefonstring
notatkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PUT "$CRM/api/organizacje/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miasto": "Warszawa"}'

Przykładowa odpowiedź

{
  "ok": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
post/api/organizacje/{id}/biala-listaOdswiezenie statusu VAT i rachunkow z bialej listy MF

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/organizacje/123/biala-lista" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
put/api/organizacje/{id}/nadrzednaZmiana firmy nadrzednej (centrali) albo odpiecie oddzialu

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nadrzedna_idinteger | nullId centrali; null odpina oddzial

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PUT "$CRM/api/organizacje/123/nadrzedna" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nadrzedna_id": 1}'

Przykładowa odpowiedź

{
  "ok": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
post/api/organizacje/{id}/oddzialyNowy oddzial firmy (bez NIP dziedziczy NIP centrali)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
nipstringNIP znanej firmy zwraca te firme zamiast duplikatu
regonstring
krsstring
ulicastring
kodstring
miastostring
email_fakturystring
wwwstring
telefonstring
notatkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/organizacje/123/oddzialy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": "Oddzial Krakow", "miasto": "Krakow"}'

Przykładowa odpowiedź

{
  "ok": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
post/api/organizacje/{id}/rejestryForma prawna i adres z KRS lub CEIDG

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nipstring
krsstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/organizacje/123/rejestry" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nip": "5260250274"}'

Przykładowa odpowiedź

{
  "ok": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
post/api/organizacje/{id}/scalScalenie drugiej firmy w te

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
zintegerId rekordu, ktory zostaje wchloniety

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/organizacje/123/scal" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"z": 3}'

Przykładowa odpowiedź

{
  "ok": true,
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}

Followupy

post/api/followupy/cisza/{id}Wlacza albo wylacza tryb ciszy klienta (telefon, pisanie, wszystko; null wylacza): blokuje automatyczny kontakt

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
ciszastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/followupy/cisza/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"cisza": ...}'
get/api/followupy/lead/{id}Plan follow-upow po ofercie, stan uspienia i flaga ciszy jednej szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/followupy/lead/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/followupy/raportLeady w toku bez zadania i terminu, pokrycie ofert zadaniem follow-upu i skutecznosc follow-upow w 48 h (dzien 3, 7 i 14)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/followupy/raport" \
  -H "Authorization: Bearer $KLUCZ"

Funkcje

get/api/funkcjeFunkcje instancji: katalog, stan dla konta, profil i flagi (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/funkcje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/funkcje/flagi/{klucz}Flaga funkcji: wlaczona, procent wdrozenia, loginy (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
wlaczonaboolean
procentinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/funkcje/flagi/<klucz>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlaczona": ..., "procent": ...}'
get/api/funkcje/uzycieAnonimowe zbiorcze uzycie funkcji z ostatnich dni (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/funkcje/uzycie" \
  -H "Authorization: Bearer $KLUCZ"

Google

get/api/google/weryfikacjaStan weryfikacji Google OAuth: tryb, CASA, zakresy, polityka prywatnosci

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/google/weryfikacja" \
  -H "Authorization: Bearer $KLUCZ"
put/api/google/weryfikacjaZapis pol listy kontrolnej weryfikacji Google (wlasciciel)

Ciało (JSON)

PoleTypOpis
film_demo_urlstring
casa_statusstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/google/weryfikacja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"film_demo_url": ..., "casa_status": ...}'

Importy

get/api/importy/partieOstatnie partie importu CSV/XLSX: etykieta, plik, liczba utworzonych szans, stan i wynik cofniecia; tylko wlasciciel

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/importy/partie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/importy/partie/{id}/cofnijCofa caly import: kopia bazy, potem usuniecie tylko szans, osob i firm utworzonych ta partia (szanse z dalsza historia handlowa zostaja); tylko wlasciciel

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/importy/partie/123/cofnij" \
  -H "Authorization: Bearer $KLUCZ"

Inne

get/polityka-prywatnosci-crmbez kluczaPubliczna polityka prywatnosci z deklaracja Limited Use

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X GET "$CRM/polityka-prywatnosci-crm"

Instancja demo

get/api/instancja_demoStan jawnej instancji demo: limity, uzycie i straznik prawdziwych danych (banner w panelu)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/instancja_demo" \
  -H "Authorization: Bearer $KLUCZ"

Integracje biznesowe

post/api/integracje/fakturaLadunek faktury Fakturownia, wFirma, iFirma

Ciało (JSON)

PoleTypOpis
systemstring
lead_idinteger
nettonumber
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/integracje/faktura" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"system": ..., "lead_id": ..., "netto": ...}'
get/api/integracje/fluxksefStan polaczenia z FluxKSeF, ostatnie faktury sprzedazy i kontrahenci (odczyt)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/integracje/fluxksef" \
  -H "Authorization: Bearer $KLUCZ"
post/api/integracje/fluxksef/synchronizujOdpytanie FluxKSeF o stan KSeF i wplaty faktur w toku

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/integracje/fluxksef/synchronizuj" \
  -H "Authorization: Bearer $KLUCZ"
post/api/integracje/fluxksef/webhookbez kluczaZdarzenie invoice.* z FluxKSeF (podpis X-FluxKSeF-Signature)

Ciało (JSON)

PoleTypOpis
typestring
invoiceobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/integracje/fluxksef/webhook" \
  -H 'Content-Type: application/json' \
  -d '{"type": ..., "invoice": ...}'
post/api/integracje/konwersjeKonwersje offline: Google Ads (CSV), Meta, GA4

Ciało (JSON)

PoleTypOpis
platformastring
lead_idinteger
wszystkie_wygraneboolean
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/integracje/konwersje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"platforma": ..., "lead_id": ..., "wszystkie_wygrane": ...}'
post/api/integracje/powiadomPowiadomienie Slack albo Teams (podglad; wyslij: true wysyla)

Ciało (JSON)

PoleTypOpis
celstring
tekststring
lead_idinteger
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/integracje/powiadom" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"cel": ..., "tekst": ..., "lead_id": ...}'
post/api/integracje/webhookZdarzenie do webhookow Zapier, Make i n8n

Ciało (JSON)

PoleTypOpis
zdarzeniestring
lead_idinteger
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/integracje/webhook" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zdarzenie": ..., "lead_id": ..., "wyslij": ...}'
post/api/integracje/zadanieZadanie w Trello, ClickUp albo Jira po wygranej

Ciało (JSON)

PoleTypOpis
systemstring
lead_idinteger
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/integracje/zadanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"system": ..., "lead_id": ..., "wyslij": ...}'
post/api/integracje/zewnetrzneGoogle Workspace, Microsoft 365, Dropbox, e-podpis, KSeF, GUS, Sanity, nagrania Meet (podglad; wyslij: true wysyla)

Ciało (JSON)

PoleTypOpis
systemstring
akcjastring
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/integracje/zewnetrzne" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"system": ..., "akcja": ..., "wyslij": ...}'

Jakosc

post/api/jakosc/cyklJednorazowy cykl jakosci: MX nowych domen, przeglad spamu, firmy z NIP, raport tygodnia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/jakosc/cykl" \
  -H "Authorization: Bearer $KLUCZ"
get/api/jakosc/emailWalidacja adresu e-mail: skladnia, domena (MX), adres wlasny, jednorazowy

Parametry

NazwaGdzieTypWymagany
adreszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/jakosc/email" \
  -H "Authorization: Bearer $KLUCZ"
get/api/jakosc/leadySzanse z ostrzezeniami o danych, od najnizszej oceny

Parametry

NazwaGdzieTypWymagany
maxzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/jakosc/leady" \
  -H "Authorization: Bearer $KLUCZ"
post/api/jakosc/osoby/polaczScalenie osoby z wielu adresow w jedna

Ciało (JSON)

PoleTypOpis
dointeger
zinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/jakosc/osoby/polacz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"do": ..., "z": ...}'
get/api/jakosc/osoby/propozycjePary osob z roznymi adresami, ktore wygladaja na jednego czlowieka

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/jakosc/osoby/propozycje" \
  -H "Authorization: Bearer $KLUCZ"
get/api/jakosc/osoby/{id}/adresyAdres glowny i dodatkowe adresy osoby

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/jakosc/osoby/123/adresy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/jakosc/osoby/{id}/adresyDopisanie adresu dodatkowego osoby

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
adresstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/jakosc/osoby/123/adresy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"adres": ...}'
get/api/jakosc/raportRaport jakosci danych za tydzien (domyslnie najnowszy), lista tygodni i tekst

Parametry

NazwaGdzieTypWymagany
tydzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/jakosc/raport" \
  -H "Authorization: Bearer $KLUCZ"
post/api/jakosc/raportLiczy raport jakosci danych od nowa (domyslnie za ostatni zakonczony tydzien)

Ciało (JSON)

PoleTypOpis
tydzienstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/jakosc/raport" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tydzien": ...}'
get/api/jakosc/spamStan filtra spamu (probki, prog) i szanse podejrzane o spam

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/jakosc/spam" \
  -H "Authorization: Bearer $KLUCZ"
get/api/jakosc/stopStop-lista z panelu: adresy, domeny i numery, z ktorymi nie kontaktujemy sie wcale

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/jakosc/stop" \
  -H "Authorization: Bearer $KLUCZ"
post/api/jakosc/stopDopisanie wpisu do stop-listy

Ciało (JSON)

PoleTypOpis
rodzajstring
wartoscstring
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/jakosc/stop" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "wartosc": ..., "powod": ...}'
delete/api/jakosc/stop/{id}Usuniecie wpisu ze stop-listy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/jakosc/stop/123" \
  -H "Authorization: Bearer $KLUCZ"

Kanaly klienta

get/api/kanaly_klientaGotowosc bramek kanalow (WhatsApp, podpis), limity i liczby wiadomosci per stan

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kanaly_klienta" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kanaly_klienta/doreczenieZdarzenie doreczenia z bramki: wyslana, doreczona, odczytana, blad

Ciało (JSON)

PoleTypOpis
idinteger
tokenstring
zdarzeniestring
szczegolstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kanaly_klienta/doreczenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "token": ..., "zdarzenie": ...}'
get/api/kanaly_klienta/dziennikDziennik doreczen z podsumowaniem per kanal

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie
kanalzapytaniestringnie
stanzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/kanaly_klienta/dziennik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kanaly_klienta/szablonySzablony wielokanalowe

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kanaly_klienta/szablony" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kanaly_klienta/szablonyNowy szablon wielokanalowy (tresci per kanal)

Ciało (JSON)

PoleTypOpis
nazwastring
tresciobject

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kanaly_klienta/szablony" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "tresci": ...}'
get/api/kanaly_klienta/szablony/{id}Szablon wielokanalowy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/kanaly_klienta/szablony/123" \
  -H "Authorization: Bearer $KLUCZ"
delete/api/kanaly_klienta/szablony/{id}Usuniecie szablonu wielokanalowego

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/kanaly_klienta/szablony/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kanaly_klienta/szablony/{id}/podgladPodglad szablonu dla szansy i kanalu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
lead_idinteger
kanalstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kanaly_klienta/szablony/123/podglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "kanal": ...}'
get/api/kanaly_klienta/wiadomosciWiadomosci kanalow do klienta (WhatsApp, wideo, podpis, mail, SMS)

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie
stanzapytaniestringnie
kanalzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kanaly_klienta/wiadomosci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kanaly_klienta/wiadomosciNowy szkic wiadomosci do klienta (nic nie wychodzi bez akcji wyslij)

Ciało (JSON)

PoleTypOpis
lead_idinteger
kanalstring
trescstring
szablon_idinteger
tematstring
przezstring
dokumentstring
celstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kanaly_klienta/wiadomosci" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "kanal": ..., "tresc": ...}'
get/api/kanaly_klienta/wiadomosci/{id}Wiadomosc z dziennikiem doreczen

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/kanaly_klienta/wiadomosci/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kanaly_klienta/wiadomosci/{id}Akcja czlowieka: wyslij (bramka albo kolejka poczty/SMS) albo odrzuc

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kanaly_klienta/wiadomosci/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'

Kanały wiadomości

get/api/kanalyStan kanalow wiadomosci: skonfigurowane, adresy webhookow, wysylka

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kanaly" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kanaly/{rodzaj}/synchronizujPobranie wiadomosci z API Allegro albo OLX (rodzaj: allegro, olx)

Parametry

NazwaGdzieTypWymagany
rodzajadresstringtak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/kanaly/<rodzaj>/synchronizuj" \
  -H "Authorization: Bearer $KLUCZ"

Katalog szablonow

get/api/katalog_szablonowMarketplace szablonow: lista, opisy, zrzuty, oceny, liczniki i stan instalacji

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/katalog_szablonow" \
  -H "Authorization: Bearer $KLUCZ"
get/api/katalog_szablonow/branzaDla twojej branzy: widoki, szkice, sekwencje i wzory z zainstalowanych szablonow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/katalog_szablonow/branza" \
  -H "Authorization: Bearer $KLUCZ"
get/api/katalog_szablonow/rozliczeniaRozliczenia platnych szablonow partnerow: podzial, niewyplacone kwoty, wyplaty (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/katalog_szablonow/rozliczenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/katalog_szablonow/rozliczenia/wyplacWyplata dla partnera po wyplacie testowej (Stripe Connect albo faktura zbiorcza)

Ciało (JSON)

PoleTypOpis
partnerklucz partnera
okresRRRR-MM

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/rozliczenia/wyplac" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"partner": ..., "okres": ...}'
post/api/katalog_szablonow/rozliczenia/wyplata-testowaWyplata testowa partnera: ta sama sciezka co prawdziwa, bez ruchu pieniedzy

Ciało (JSON)

PoleTypOpis
partnerklucz partnera
okresRRRR-MM

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/rozliczenia/wyplata-testowa" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"partner": ..., "okres": ...}'
post/api/katalog_szablonow/zglosZgloszenie paczki szablonu partnera do przegladu

Ciało (JSON)

PoleTypOpis
paczkaobiekt paczki
partnerklucz partnera
kontaktkontakt

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/zglos" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"paczka": ..., "partner": ..., "kontakt": ...}'
get/api/katalog_szablonow/zgloszeniaZgloszone paczki partnerow z wynikiem skanu (wlasciciel)

Parametry

NazwaGdzieTypWymagany
stanzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/katalog_szablonow/zgloszenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/katalog_szablonow/zgloszenia/przegladDecyzja o zgloszeniu partnera: publikuj (wymaga przeglad_bezpieczenstwa), odrzuc, wycofaj

Ciało (JSON)

PoleTypOpis
idid szablonu
wersjawersja
decyzjapublikuj|odrzuc|wycofaj
uwagiuwagi
przeglad_bezpieczenstwaprawda po przegladzie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/zgloszenia/przeglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "wersja": ..., "decyzja": ...}'
get/api/katalog_szablonow/{id}Szczegoly szablonu z wynikiem skanu paczki

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/katalog_szablonow/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/katalog_szablonow/{id}/aktualizacjaRoznica miedzy zainstalowana a najnowsza wersja szablonu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/katalog_szablonow/123/aktualizacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/katalog_szablonow/{id}/aktualizujAktualizacja do najnowszej wersji; zmiany klienta zostaja

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
czescilista czesci: struktura, komunikacja, widoki, dokumenty (puste = wszystkie)
zgoda_zewnetrznezgoda na adresy zewnetrzne

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/123/aktualizuj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"czesci": ..., "zgoda_zewnetrzne": ...}'
post/api/katalog_szablonow/{id}/cofnijCofniecie instalacji: usuwa tylko to, czego klient nie zmienil

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
czescilista czesci: struktura, komunikacja, widoki, dokumenty (puste = wszystkie)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/123/cofnij" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"czesci": ...}'
post/api/katalog_szablonow/{id}/instalujInstalacja czesci szablonu bez nadpisywania danych (platne wymagaja platnosc_ref, kod 402)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
czescilista czesci: struktura, komunikacja, widoki, dokumenty (puste = wszystkie)
zgoda_zewnetrznezgoda na adresy zewnetrzne i webhooki z paczki
platnosc_refreferencja platnosci

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 402 Payment Required
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/123/instaluj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"czesci": ..., "zgoda_zewnetrzne": ..., "platnosc_ref": ...}'
post/api/katalog_szablonow/{id}/ocenaOcena szablonu 1-5 po instalacji

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
ocena1-5
komentarzkomentarz

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/123/ocena" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ocena": ..., "komentarz": ...}'
post/api/katalog_szablonow/{id}/podgladPodglad instalacji: co zostanie dodane, co pominiete (kolizje)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
czescilista czesci: struktura, komunikacja, widoki, dokumenty (puste = wszystkie)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/katalog_szablonow/123/podglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"czesci": ...}'

Klienci

get/api/klienciRejestr klientow po sprzedazy: wdrozenie, faktury, proformy, zgloszenia i sygnal dosprzedazy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/klienci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/klienci/kartaKarta klienta: umowy, faktury, proformy, raty, projekty, abonamenty, reklamacje, opinie, polecenia, LTV i ryzyko odejscia

Parametry

NazwaGdzieTypWymagany
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/klienci/karta" \
  -H "Authorization: Bearer $KLUCZ"
get/api/klienci/ltvNajlepsi klienci wg LTV (umowy, dodatki, abonamenty)

Parametry

NazwaGdzieTypWymagany
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/klienci/ltv" \
  -H "Authorization: Bearer $KLUCZ"
post/api/klienci/wdrozenieUstaw stan wdrozenia wygranego klienta (pusty wraca do wyliczanego z projektu)

Ciało (JSON)

PoleTypOpis
leadinteger
stanstring

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/klienci/wdrozenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead": ..., "stan": ...}'
get/api/klienci/zagrozeniKlienci zagrozeni odejsciem (wskaznik 0-100 z powodami)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/klienci/zagrozeni" \
  -H "Authorization: Bearer $KLUCZ"

Klucze API

get/api/meInstancja, klucz (typ, zakres, tryb, sandbox) i pozostaly limit zadan

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/me" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "wersja_api": "1",
  "wycofanie": null,
  "instancja": {
    "nazwa": "FluxLab",
    "adres": "https://crm.example.pl",
    "demo": false
  },
  "klucz": {
    "typ": "integracja",
    "nazwa": "Zapier",
    "prefiks": "fxk_aB3dE9",
    "zakres": [
      "szanse"
    ],
    "tryb": "zapis",
    "wygasa": null,
    "ostatnio": "2026-11-01T10:00:00",
    "sandbox": false
  },
  "konto": null,
  "limity": {
    "minuta": {
      "limit": 60,
      "pozostalo": 59,
      "reset_s": 60
    },
    "doba": {
      "limit": 10000,
      "pozostalo": 9999,
      "reset_s": 86400
    }
  }
}

Klucze api

get/api/klucze_apiKlucze API bez wartosci: zakres, tryb, wygasanie, limity, ostatnie uzycie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/klucze_api" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "klucze": [
    {
      "id": 1,
      "nazwa": "Zapier",
      "prefiks": "fxk_aB3dE9",
      "zakres": [
        "szanse",
        "zadania"
      ],
      "tryb": "zapis",
      "wygasa": "2027-10-28T09:00:00",
      "wygasl": false,
      "limit_min": 60,
      "limit_dzien": 10000,
      "aktywny": true,
      "utworzono": "2026-10-28T09:00:00",
      "ostatnio": null
    }
  ],
  "moduly": [
    {
      "klucz": "szanse",
      "nazwa": "Szanse i klienci"
    }
  ]
}
post/api/klucze_apiAkcje na kluczach: utworz (wartosc widac raz), cofnij, przedluz, limity, rotuj (nowy klucz, stary zyje 24 h), ip (lista IP lub CIDR)

Ciało (JSON)

PoleTypOpis
akcjastring
nazwastringutworz: nazwa integracji
zakresarrayutworz
trybstringutworz
dniintegerutworz i przedluz: waznosc w dniach (utworz bez dni = bez terminu)
limit_minintegerutworz i limity: zadan na minute (puste = 60)
limit_dzienintegerutworz i limity: zadan na dobe (puste = 10 000)
idintegercofnij, przedluz, limity, rotuj, ip
sandboxbooleanutworz: klucz testowy, dziala tylko na bazie demo z danymi przykladowymi

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/klucze_api" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": "utworz", "nazwa": "Zapier", "zakres": ["szanse", "zadania"], "tryb": "zapis", "dni": 365, "limit_min": 60, "limit_dzien": 10000}'

Przykładowa odpowiedź

{
  "ok": true,
  "klucz": "fxk_aB3dE9...pokazany-raz",
  "opis": {
    "id": 1,
    "nazwa": "Zapier",
    "prefiks": "fxk_aB3dE9",
    "zakres": [
      "szanse",
      "zadania"
    ],
    "tryb": "zapis",
    "wygasa": "2027-10-28T09:00:00",
    "wygasl": false,
    "limit_min": 60,
    "limit_dzien": 10000,
    "aktywny": true,
    "utworzono": "2026-10-28T09:00:00",
    "ostatnio": null
  }
}

Klucze uzycie

get/api/klucze_uzycieDziennik uzycia klucza API: ostatnie 100 wywolan z trasa, kodem i IP (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/klucze_uzycie" \
  -H "Authorization: Bearer $KLUCZ"

Kolejka akceptacji

get/api/akceptacjaKolejka CRM i kolejka Fluxdesku do decyzji z telefonu (wlasciciel i handlowiec)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/akceptacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/akceptacja/{id}Decyzja o pozycji kolejki Fluxdesku: akceptuj, anuluj z powodem albo popraw tresc

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring
powodstring
uwagastring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/akceptacja/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "powod": ..., "uwaga": ...}'
get/api/auto_odpowiedzAutomatyczna odpowiedz: ustawienia, gotowosc kanalow, kolejka, podglad

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/auto_odpowiedz" \
  -H "Authorization: Bearer $KLUCZ"
post/api/auto_odpowiedzZapis [auto_odpowiedz]: wlaczone, tryb, kanaly, szablony, godziny (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
wlaczoneboolean
trybstring
kanalyarray
temat_mailstring
szablon_mailstring
szablon_smsstring
godziny_pracystring
termin_oddzwonienia_mininteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/auto_odpowiedz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlaczone": ..., "tryb": ..., "kanaly": ...}'
post/api/auto_odpowiedz/kolejkaWyslanie albo odrzucenie auto-odpowiedzi z kolejki CRM

Ciało (JSON)

PoleTypOpis
idinteger
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/auto_odpowiedz/kolejka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "akcja": ...}'
post/api/auto_odpowiedz/podgladPodglad auto-odpowiedzi dla leada z niezapisanych szablonow

Ciało (JSON)

PoleTypOpis
lead_idinteger
szablon_mailstring
szablon_smsstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/auto_odpowiedz/podglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "szablon_mail": ..., "szablon_sms": ...}'

Kompletnosc

get/api/kompletnoscKompletnosc aktywnych szans: procent wg wag pol i etapu oraz lista brakow, najpierw te, na ktore czekamy

Parametry

NazwaGdzieTypWymagany
limitzapytaniestringnie
makszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kompletnosc" \
  -H "Authorization: Bearer $KLUCZ"

Konta i role

get/api/uzytkownicyKonta i role (wlasciciel albo klucz glowny)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/uzytkownicy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/uzytkownicyAkcja na koncie: dodaj, rola, wylacz, wlacz, haslo, totp_wlacz, totp_wylacz

Ciało (JSON)

PoleTypOpis
akcjastring
loginstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/uzytkownicy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "login": ...}'

Kontomatik

get/api/kontomatik/zgoda/{token}bez kluczaStrona zgody z widgetem Kontomatik (publiczna)

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/kontomatik/zgoda/<token>"
post/api/kontomatik/zgoda/{token}bez kluczaSesja z widgetu Kontomatik (publiczna, raz)

Ciało (JSON)

PoleTypOpis
sesjastring
podpisstring

Odpowiedzi

  • 202 Przyjęto do kolejki
  • 404 Nie znaleziono
  • 409 Konflikt

Przykład

curl -sS -X POST "$CRM/api/kontomatik/zgoda/<token>" \
  -H 'Content-Type: application/json' \
  -d '{"sesja": ..., "podpis": ...}'
get/api/kontomatik/zgoda/{token}/stanbez kluczaStan importu po zgodzie (publiczna)

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/kontomatik/zgoda/<token>/stan"

Kopie

get/api/kopieStan kopii zapasowych (ostatnia kopia, alarm, RPO/RTO, retencja) i opis, co dzieje się z danymi (tylko właściciel)

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kopie" \
  -H "Authorization: Bearer $KLUCZ"

Kredyty

get/api/bankiSlownik bankow instancji, banki dopisane we wnioskach i statusy wnioskow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/banki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/dokumentyZestawy dokumentow instancji, stany pozycji i pole celu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/dokumenty" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/aktualnoscProdukty bankowe bez aktualizacji ponad 60 dni (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kredyty/aktualnosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/bankiDane bankow i umowy agencyjne z terminami (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kredyty/banki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/banki-umowyUmowy agencyjne z bankami (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kredyty/banki-umowy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kredyty/banki-umowyUmowa agencyjna z bankiem: numer i data, pusty numer usuwa (wlasciciel)

Ciało (JSON)

PoleTypOpis
bankstring
numerstring
datastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/banki-umowy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"bank": ..., "numer": ..., "data": ...}'
get/api/kredyty/knfWynik kontroli wpisu w rejestrze KNF (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kredyty/knf" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kredyty/knfSprawdza wpis w rejestrze KNF albo zapisuje sprawdzenie reczne (wlasciciel)

Ciało (JSON)

PoleTypOpis
wynikstring
numerstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/knf" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wynik": ..., "numer": ...}'
get/api/kredyty/posrednikStan zgodnosci posrednika: braki, blokada wysylki, terminy (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kredyty/posrednik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/produktyBaza produktow bankowych z warunkami

Parametry

NazwaGdzieTypWymagany
bankzapytaniestringnie
celzapytaniestringnie
wszystkiezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kredyty/produkty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kredyty/produktyNowy produkt bankowy (wlasciciel)

Ciało (JSON)

PoleTypOpis
bankstring
produktstring
warunkiobject

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/produkty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"bank": ..., "produkt": ..., "warunki": ...}'
post/api/kredyty/produkty/{id}Zmiana produktu bankowego (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
warunkiobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/produkty/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"warunki": ...}'
get/api/kredyty/prowizje/doradcyRozliczenie prowizji doradcow w miesiacu, csv=1 dla ksiegowej (wlasciciel)

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie
csvzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/kredyty/prowizje/doradcy" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/prowizje/niewyplaconeProwizje bez wplywu po uruchomieniu kredytu (wlasciciel)

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/kredyty/prowizje/niewyplacone" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/prowizje/przychodPrzychod per bank i produkt w miesiacu, zgodnosc z ksiegowoscia (wlasciciel)

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie
ksiegowosczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/kredyty/prowizje/przychod" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/prowizje/stawkiStawki prowizji per bank i produkt (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kredyty/prowizje/stawki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kredyty/prowizje/stawkiZapis stawki banku: proc, minimum, maksimum, obowiazuje_od (wlasciciel)

Ciało (JSON)

PoleTypOpis
bankstring
produktstring
procnumber
minimumnumber
maksimumnumber
obowiazuje_odstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/prowizje/stawki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"bank": ..., "produkt": ..., "proc": ...}'
post/api/kredyty/prowizje/wyciagImport wyciagu CSV: dopasowanie wplywow prowizji do spraw (wlasciciel)

Ciało (JSON)

PoleTypOpis
csvstring
zapiszboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/prowizje/wyciag" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"csv": ..., "zapisz": ...}'
get/api/kredyty/refinansowanieKandydaci do refinansowania po splacie kredytu

Parametry

NazwaGdzieTypWymagany
miesiecyzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/kredyty/refinansowanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kredyty/refinansowanieTag, segment i szkic kampanii refinansowania (wlasciciel)

Ciało (JSON)

PoleTypOpis
miesiecyinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/refinansowanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miesiecy": ...}'
get/api/kredyty/terminyOC, szkolenie i wpis KNF z terminem w ciagu 60 dni

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kredyty/terminy" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/uprawnieniaZakres uprawnien doradcow (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/kredyty/uprawnienia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kredyty/uprawnieniaZakres uprawnien doradcy: hipoteczne, gotowkowe, firmowe, ubezpieczenia (wlasciciel)

Ciało (JSON)

PoleTypOpis
opiekunstring
zakresarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/uprawnienia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"opiekun": ..., "zakres": ...}'
get/api/kredyty/zdolnoscKalkulator zdolnosci kredytowej

Parametry

NazwaGdzieTypWymagany
dochodzapytaniestringnie
zobowiazaniazapytaniestringnie
okreszapytaniestringnie
oprocentowaniezapytaniestringnie
doroslizapytaniestringnie
dziecizapytaniestringnie
kosztyzapytaniestringnie
dstizapytaniestringnie
buforzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/kredyty/zdolnosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/kredyty/zgodnoscZgodnosc posrednika kredytowego: rejestr, OC, szkolenia, ostrzezenia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/kredyty/zgodnosc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/kredyty/zgodnoscWpis zgodnosci posrednika (wlasciciel)

Ciało (JSON)

PoleTypOpis
kluczstring
wartoscstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/kredyty/zgodnosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klucz": ..., "wartosc": ...}'

Lejki

get/api/lejkiLejki sprzedazy instancji z etapami ([lejek] to lejek domyslny, [[lejki]] kolejne)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/lejki" \
  -H "Authorization: Bearer $KLUCZ"

Liczby i raporty

get/api/liczbyLiczby: skad, czas odpowiedzi, wynik; z grupa=opiekun|zrodlo|kampania tabela per doradca, zrodlo albo kampania, z raport=lejek|przychod|przegrane|waskie_gardla|porownanie|odmowy|rozliczenia|prognozy|koszt_zrodel|handlowcy|klienci|anomalie|jakosc|co_zmienic|koszt_ai|jakosc_szkicow|koszt_kampanii|kohorty|ltv_kanalow|wyniki_kampanii|alerty raporty zakladek (handlowiec widzi tylko swoje); czekal.per_lead stronami (per_lead_od, per_lead_limit, per_lead_nastepny), mediana z calosci w czekal.mediana_odpowiedzi_min

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie
grupazapytaniestringnie
raportzapytaniestringnie
per_lead_odzapytaniestringnie
per_lead_limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/liczby" \
  -H "Authorization: Bearer $KLUCZ"
get/api/raport_miesiecznyRaport miesieczny dla wlasciciela jako PDF (miesiac=RRRR-MM, domyslnie ostatni pelny); tylko wlasciciel

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/raport_miesieczny" \
  -H "Authorization: Bearer $KLUCZ"

Logowania

get/api/logowaniaDziennik logowan z urzadzeniem i IP (wlasciciel: dowolne konto, inni: swoj)

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/logowania" \
  -H "Authorization: Bearer $KLUCZ"

Logowanie

get/api/jabez kluczaKto jest zalogowany

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/ja"
post/api/ja/wprowadzeniebez kluczaKonto z sesji widzialo wprowadzenie w panelu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/ja/wprowadzenie"
post/api/wylogujbez kluczaKoniec sesji

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X POST "$CRM/api/wyloguj"
post/api/zalogujbez kluczaLogowanie kontem: ciasteczko fluxcrm_sesja

Ciało (JSON)

PoleTypOpis
loginstring
haslostring
kodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/zaloguj" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "haslo": ..., "kod": ...}'

Lojalnosc

get/api/lojalnoscRanking lojalnosci i zasady punktow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/lojalnosc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/lojalnosc/przeliczNaliczenie punktow z umow, polecen i ankiet (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/lojalnosc/przelicz" \
  -H "Authorization: Bearer $KLUCZ"

Marketing

get/api/marketing/ankietyWynik NPS

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/marketing/ankiety" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/audytyWykonane audyty stron

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/audyty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/audytyAudyt strony (wynik 0-100 i zalecenia)

Ciało (JSON)

PoleTypOpis
adresstring
lead_idinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/audyty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"adres": ..., "lead_id": ...}'
get/api/marketing/audyty/{id}Raport audytu strony

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/marketing/audyty/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/budzetBudzet marketingowy miesiaca: plan vs wydatki, prognoza

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/marketing/budzet" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/budzetUstawienie budzetu miesiaca/kampanii (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
miesiacstring
kampaniastring
kwotanumber

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/budzet" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miesiac": ..., "kampania": ..., "kwota": ...}'
delete/api/marketing/budzet/{miesiac}/{kampania}Usuniecie budzetu miesiaca/kampanii (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X DELETE "$CRM/api/marketing/budzet/<miesiac>/<kampania>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/chatbotPytania chatbota kwalifikujacego

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/chatbot" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/gbpWiadomosc z Google Business Profile jako szansa

Ciało (JSON)

PoleTypOpis
rozmowastring
tekststring
nazwastring
sekretstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/gbp" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rozmowa": ..., "tekst": ..., "nazwa": ...}'
get/api/marketing/kalendarzKalendarz publikacji: tresci, wydarzenia, kampanie mailowe

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/kalendarz" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/kampanieKampanie mailowe i newslettery

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/kampanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/kampanieNowa kampania z wariantem B (A/B)

Ciało (JSON)

PoleTypOpis
nazwastring
segment_idinteger
temat_astring
tresc_astring
temat_bstring
tresc_bstring
limit_dziennyinteger
godzinystring
startstring
rodzajstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/kampanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "segment_id": ..., "temat_a": ...}'
get/api/marketing/kampanie/{id}Wyniki kampanii: wysylki, odpowiedzi, wariant wygrywajacy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/marketing/kampanie/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/kampanie/{id}Przygotuj (szkice maili), zatwierdz (terminy wg limitu, tylko wlasciciel) albo anuluj

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/kampanie/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'
get/api/marketing/kosztyKoszty reklam kampanii

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/koszty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/kosztyKoszt reklamy kampanii (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
kampaniastring
odstring
dostring
kwotanumber

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/koszty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kampania": ..., "od": ..., "do": ...}'
delete/api/marketing/koszty/{id}Usuniecie kosztu (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/marketing/koszty/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/landingiLandingi z formularzem: adres, odslony, zgloszenia, kod do osadzenia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/landingi" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/landingiNowy landing (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
slugstring
tytulstring
naglowekstring
opisstring
polaarray
kalkulatorstring
chatbotboolean
kampaniastring
originyarray

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/landingi" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"slug": ..., "tytul": ..., "naglowek": ...}'
get/api/marketing/landingi/{slug}Landing z kodem do osadzenia i dyrektywami CSP

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/marketing/landingi/<slug>" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/landingi/{slug}Zmiana landingu albo odnow_token (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
tytulstring
aktywnaboolean
odnow_tokenboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/landingi/<slug>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "aktywna": ..., "odnow_token": ...}'
delete/api/marketing/landingi/{slug}Usuniecie landingu (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/marketing/landingi/<slug>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/markaPomiar marki: wzmianki, sentyment, zrodla, tygodnie

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/marka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/marka/odswiezOdczyt kanalow RSS/Atom wzmianek (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/marka/odswiez" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/opinieOpinie zatwierdzone do publikacji

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/opinie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/opinie/z-ankietSzkice opinii z ankiet NPS (zgoda na publikacje do potwierdzenia)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/opinie/z-ankiet" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/outreachKolejka cold mailingu B2B i LinkedIn z zasadami

Parametry

NazwaGdzieTypWymagany
kanalzapytaniestringnie
stanzapytaniestringnie
kampaniazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/outreach" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/outreachDodanie kontaktow do outreach (tylko wlasciciel; odrzuca kontakty bez zrodla danych, prywatne, wykluczone)

Ciało (JSON)

PoleTypOpis
kampaniastring
kanalstring
kontaktyarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/outreach" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kampania": ..., "kanal": ..., "kontakty": ...}'
post/api/marketing/outreach/{id}/akcjaWynik reczny: wyslano, zaakceptowano, odpowiedz, pomin (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/outreach/123/akcja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'
post/api/marketing/outreach/{id}/szkicSzkic maila cold mailingu albo tresc zaproszenia LinkedIn (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tematstring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/outreach/123/szkic" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"temat": ..., "tresc": ...}'
get/api/marketing/poleceniaProgram polecen: kody, polecone szanse, nagrody

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/polecenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/polecenia/{id}/nagrodaPrzyznanie nagrody za polecenie (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nagrodastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/marketing/polecenia/123/nagroda" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nagroda": ...}'
get/api/marketing/popupyPop-upy z oferta: statystyki i kod do osadzenia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/popupy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/popupyNowy pop-up z oferta (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
nazwastring
landing_slugstring
naglowekstring
trescstring
przyciskstring
wyzwalaczstring
wartoscinteger
stronyarray
czestosc_dniinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/popupy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "landing_slug": ..., "naglowek": ...}'
post/api/marketing/popupy/{id}Zmiana pop-upu (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
naglowekstring
aktywnyboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/popupy/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"naglowek": ..., "aktywny": ...}'
delete/api/marketing/popupy/{id}Usuniecie pop-upu (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/marketing/popupy/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/portale/importImport powiadomienia portalu (Oferteo, Fixly) jako szansy

Ciało (JSON)

PoleTypOpis
portalstring
tematstring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/portale/import" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"portal": ..., "temat": ..., "tresc": ...}'
get/api/marketing/pozyskiwanieLiczniki i gotowosc pakietu pozyskiwania

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/pozyskiwanie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/remarketingAudiencje remarketingowe wg etapu z liczba osob ze zgoda

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/remarketing" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/remarketing/{klucz}/eksportLista Customer Match (CSV z haszami SHA-256) dla Google albo Meta (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
platformazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/marketing/remarketing/<klucz>/eksport" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/retencjaRetencja klientow: kohorty miesieczne i churn (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
miesiecyzapytaniestringnie
oknozapytaniestringnie
miarazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/marketing/retencja" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/roiROI kampanii: szanse, wygrane, koszt leada, ROI

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/marketing/roi" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/segmentySegmenty klientow z liczba odbiorcow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/segmenty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/segmentyNowy segment z filtrem

Ciało (JSON)

PoleTypOpis
nazwastring
filtrobject

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/segmenty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "filtr": ...}'
get/api/marketing/segmenty/{id}Podglad segmentu: liczba, wykluczeni z powodami, przyklad

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/marketing/segmenty/123" \
  -H "Authorization: Bearer $KLUCZ"
delete/api/marketing/segmenty/{id}Usuniecie segmentu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X DELETE "$CRM/api/marketing/segmenty/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/seo-pytaniaPytania klientow pogrupowane w tematy artykulow SEO

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/seo-pytania" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/seo-pytaniaSzkic artykulu SEO z pytan klientow

Ciało (JSON)

PoleTypOpis
tytulstring
pytaniaarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/seo-pytania" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "pytania": ...}'
get/api/marketing/tresciTresci marketingowe: posty, case studies, opinie, artykuly

Parametry

NazwaGdzieTypWymagany
rodzajzapytaniestringnie
stanzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/tresci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/tresciNowa tresc marketingowa (szkic)

Ciało (JSON)

PoleTypOpis
rodzajstring
tytulstring
trescstring
kanalstring
zaplanowanostring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/tresci" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "tytul": ..., "tresc": ...}'
post/api/marketing/tresci/z-wygranejSzkic posta albo case study z wygranej szansy

Ciało (JSON)

PoleTypOpis
lead_idinteger
rodzajstring
zgoda_publikacjiboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/tresci/z-wygranej" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "rodzaj": ..., "zgoda_publikacji": ...}'
post/api/marketing/tresci/{id}Zmiana tresci albo akcja zatwierdz, odrzuc, opublikowano, cofnij

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tytulstring
trescstring
akcjastring
zaplanowanostring
zgoda_publikacjiboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/tresci/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "tresc": ..., "akcja": ...}'
delete/api/marketing/tresci/{id}Usuniecie tresci

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/marketing/tresci/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/marketing/wydarzeniaWebinary i eventy z liczba rejestracji

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/marketing/wydarzenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/wydarzeniaNowe wydarzenie z publiczna rejestracja (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
slugstring
rodzajstring
tytulstring
startstring
opisstring
miejscestring
linkstring
limit_miejscinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/wydarzenia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"slug": ..., "rodzaj": ..., "tytul": ...}'
get/api/marketing/wydarzenia/{id}Wydarzenie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/marketing/wydarzenia/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/wydarzenia/{id}Zmiana wydarzenia (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tytulstring
startstring
aktywneboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/wydarzenia/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "start": ..., "aktywne": ...}'
delete/api/marketing/wydarzenia/{id}Usuniecie wydarzenia (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/marketing/wydarzenia/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/wydarzenia/{id}/obecnoscOznaczenie obecnosci (emaile z platformy webinarowej, zamkniecie listy)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
emailearray
stanstring
rejestracja_idinteger
zamknijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/wydarzenia/123/obecnosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"emaile": ..., "stan": ..., "rejestracja_id": ...}'
get/api/marketing/wydarzenia/{id}/rejestracjeLista rejestracji i obecnosci

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/marketing/wydarzenia/123/rejestracje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/marketing/wzmiankiNowa wzmianka o marce

Ciało (JSON)

PoleTypOpis
urlstring
zrodlostring
tytulstring
fragmentstring
sentymentinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/marketing/wzmianki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"url": ..., "zrodlo": ..., "tytul": ...}'

Mcp

post/api/mcpbez kluczaMCP przez HTTP (Streamable HTTP): jedna wiadomosc JSON-RPC, klucz w Authorization: Bearer

Ciało (JSON)

PoleTypOpis
jsonrpcstring
idinteger
methodstring
paramsobject

Odpowiedzi

  • 200 OK
  • 202 Przyjęto do kolejki
  • 400 Zły format żądania
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/mcp" \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc": ..., "id": ..., "method": ...}'
get/api/mcp/dziennikDziennik wywolan MCP: ostatnie 200 (narzedzie, argumenty bez danych wrazliwych, klucz, wynik), tylko wlasciciel

Parametry

NazwaGdzieTypWymagany
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/mcp/dziennik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/mcp/oauth/authorizebez kluczaEkran zgody OAuth dla MCP (wlasciciel zalogowany w panelu wybiera zestawy i tryb)

Parametry

NazwaGdzieTypWymagany
client_idzapytaniestringnie
redirect_urizapytaniestringnie
response_typezapytaniestringnie
code_challengezapytaniestringnie
code_challenge_methodzapytaniestringnie
statezapytaniestringnie
scopezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 400 Zły format żądania
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/mcp/oauth/authorize"
post/api/mcp/oauth/registerbez kluczaRejestracja klienta OAuth dla MCP (RFC 7591)

Ciało (JSON)

PoleTypOpis
client_namestring
redirect_urisarray

Odpowiedzi

  • 201 Utworzono
  • 400 Zły format żądania

Przykład

curl -sS -X POST "$CRM/api/mcp/oauth/register" \
  -H 'Content-Type: application/json' \
  -d '{"client_name": ..., "redirect_uris": ...}'
post/api/mcp/oauth/tokenbez kluczaToken OAuth dla MCP: authorization_code z PKCE albo refresh_token

Ciało (JSON)

PoleTypOpis
grant_typestring
codestring
code_verifierstring
client_idstring
redirect_uristring
refresh_tokenstring

Odpowiedzi

  • 200 OK
  • 400 Zły format żądania

Przykład

curl -sS -X POST "$CRM/api/mcp/oauth/token" \
  -H 'Content-Type: application/json' \
  -d '{"grant_type": ..., "code": ..., "code_verifier": ...}'

Meta

get/api/meta/instagramLeady z Instagrama: kanal odpowiedzi z karty i okno 24 h

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/meta/instagram" \
  -H "Authorization: Bearer $KLUCZ"
get/api/meta/kolejkaSzkice odpowiedzi do Messengera i Instagrama fanpage czekajace na akceptacje

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/meta/kolejka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/meta/kolejka/{id}Akceptacja, odrzucenie albo reczne ponowienie szkicu odpowiedzi (tylko sesja konta); wysylka przez fluxcrm meta-skrzynka

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/meta/kolejka/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "tresc": ...}'
get/api/meta/plan-apiPlan migracji skrzynki fanpage z CDP na Graph API: kamienie, stan i tryb pracy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/meta/plan-api" \
  -H "Authorization: Bearer $KLUCZ"
get/api/meta/zalacznikiZalaczniki klientow bez pliku i duplikaty leadow po numerze

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/meta/zalaczniki" \
  -H "Authorization: Bearer $KLUCZ"

Metryki

get/api/metrykiMetryki Prometheus (text/plain): zadania wg trasy i klasy statusu, histogram czasu, uptime, leady, rozmiar bazy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/metryki" \
  -H "Authorization: Bearer $KLUCZ"

Moj rok

get/api/moj_rokTwoj rok w CRM: wygrane, zadania, seria dni i odznaki zalogowanego konta

Parametry

NazwaGdzieTypWymagany
rokzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/moj_rok" \
  -H "Authorization: Bearer $KLUCZ"

Nagrania

post/api/nagrania/importImport reczny pliku audio do karty szansy (cialo binarne)

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie
rozszerzeniezapytaniestringnie
czas_szapytaniestringnie

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 413 Content Too Large
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/nagrania/import" \
  -H "Authorization: Bearer $KLUCZ"
get/api/nagrania/lead/{id}Nagrania szansy (wlasciciel i opiekun)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/nagrania/lead/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/nagrania/wskaznikiOdsetek rozmow z nagraniem, bledy pobrania i alert gdy ponizej progu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/nagrania/wskazniki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/nagrania/zasadyPodstawa prawna nagrywania, zapowiedz, klauzula do umowy i decyzja o nagrywaniu z telefonu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/nagrania/zasady" \
  -H "Authorization: Bearer $KLUCZ"
get/api/nagrania/{id}/dziennikDziennik odsluchow i usuniec nagrania (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/nagrania/123/dziennik" \
  -H "Authorization: Bearer $KLUCZ"
post/api/nagrania/{id}/oznaczWyjatek od retencji nagrania (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
oznaczoneboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/nagrania/123/oznacz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"oznaczone": ...}'
get/api/nagrania/{id}/plikOdsluch nagrania (Range), zapisany w dzienniku

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 206 Partial Content
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/nagrania/123/plik" \
  -H "Authorization: Bearer $KLUCZ"
post/api/nagrania/{id}/transkrypcjaTranskrypcja nagrania na zadanie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/nagrania/123/transkrypcja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/nagrania/{id}/usunUsuniecie nagrania i transkryptu na zadanie klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
potwierdzenieboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/nagrania/123/usun" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"potwierdzenie": ...}'
post/api/nagrania/{id}/znacznikiZnacznik na osi czasu nagrania

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tnumber
tekststring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/nagrania/123/znaczniki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"t": ..., "tekst": ...}'

Notatki

delete/api/notatki/{id}Usuniecie notatki (id notatki)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X DELETE "$CRM/api/notatki/123" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "notatki": [],
  "zadania": [],
  "id": 5
}

Nowosci

get/api/nowosciNotatki wydan (co nowego po aktualizacji); od=RRRR-MM-DD zwraca tylko nowsze

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/nowosci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/nowosci/przeczytaneZamkniecie okna Co nowego: zapamietuje dla uzytkownika date najnowszego wydania

Ciało (JSON)

PoleTypOpis
datastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/nowosci/przeczytane" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"data": ...}'

Nps ankieta

get/api/nps_ankietaCzy pokazac ankiete NPS (po 30 dniach od startu instancji, potem co 90 dni)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/nps_ankieta" \
  -H "Authorization: Bearer $KLUCZ"
post/api/nps_ankietaZapis odpowiedzi ankiety NPS (ocena 0-10 i komentarz)

Ciało (JSON)

PoleTypOpis
ocenainteger
komentarzstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/nps_ankieta" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ocena": ..., "komentarz": ...}'
get/api/nps_ankieta/odpowiedziOdpowiedzi ankiet NPS instancji do pobrania przez operatora

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/nps_ankieta/odpowiedzi" \
  -H "Authorization: Bearer $KLUCZ"

Oauth

get/api/oauth/microsoft/powrotbez kluczaPowrot z Entra ID po zgodzie (302 na panel)

Parametry

NazwaGdzieTypWymagany
codezapytaniestringnie
statezapytaniestringnie

Odpowiedzi

  • 302 Found

Przykład

curl -sS -X GET "$CRM/api/oauth/microsoft/powrot"

Oauth2

get/api/oauth2/aplikacjeZarejestrowane aplikacje OAuth (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/oauth2/aplikacje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/oauth2/aplikacjeRejestracja aplikacji OAuth: nazwa i adresy powrotu; akcja wylacz (wlasciciel)

Ciało (JSON)

PoleTypOpis
nazwastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/oauth2/aplikacje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ...}'
post/api/oauth2/tokenbez kluczaOAuth 2.0: wymiana kodu autoryzacji (PKCE) albo tokenu odswiezania na token dostepu (bez logowania)

Ciało (JSON)

PoleTypOpis
grant_typestring
client_idstring

Odpowiedzi

  • 200 OK
  • 400 Zły format żądania
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/oauth2/token" \
  -H 'Content-Type: application/json' \
  -d '{"grant_type": ..., "client_id": ...}'
get/api/oauth2/zgodaOAuth 2.0: opis zadania autoryzacji dla ekranu zgody (wlasciciel)

Odpowiedzi

  • 200 OK
  • 400 Zły format żądania
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/oauth2/zgoda" \
  -H "Authorization: Bearer $KLUCZ"
post/api/oauth2/zgodaOAuth 2.0: zatwierdzenie zgody, zwraca adres powrotu z kodem (wlasciciel)

Ciało (JSON)

PoleTypOpis
client_idstring
redirect_uristring

Odpowiedzi

  • 200 OK
  • 400 Zły format żądania
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/oauth2/zgoda" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"client_id": ..., "redirect_uri": ...}'
get/api/oauth2/zgodyPolaczone aplikacje: zakres, data zgody, ostatnie uzycie (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/oauth2/zgody" \
  -H "Authorization: Bearer $KLUCZ"
post/api/oauth2/zgodyCofniecie zgody aplikacji: akcja cofnij, id (wlasciciel)

Ciało (JSON)

PoleTypOpis
akcjastring
idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/oauth2/zgody" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "id": ...}'

Odpowiedzi

get/api/odpowiedzi/macierzMacierz zrodlo kontra kanal odpowiedzi z karty: leady z kanalem i bez (powod, akcja), wylaczone kanaly

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/odpowiedzi/macierz" \
  -H "Authorization: Bearer $KLUCZ"
get/api/odpowiedzi/raportRaport odpowiedzi per zrodlo: odsetek leadow z odpowiedzia z karty (cel 90%), odpowiedzi poza CRM per kanal

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/odpowiedzi/raport" \
  -H "Authorization: Bearer $KLUCZ"

Oferty i płatności

get/api/fragmenty_ofertBiblioteka fragmentow ofert

Parametry

NazwaGdzieTypWymagany
wszystkiezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/fragmenty_ofert" \
  -H "Authorization: Bearer $KLUCZ"
post/api/fragmenty_ofertDodanie, zmiana i usuniecie fragmentu oferty (wlasciciel)

Ciało (JSON)

PoleTypOpis
akcjastring
idinteger
nazwastring
kategoriastring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/fragmenty_ofert" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "id": ..., "nazwa": ...}'
get/api/naleznosciZestawienie naleznosci z przedzialami po terminie

Parametry

NazwaGdzieTypWymagany
na_dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/naleznosci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/naleznosci/ciagloscKontrola ciaglosci numeracji faktur i proform oraz czasy przyjecia w KSeF

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/naleznosci/ciaglosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/naleznosci/do_wystawieniaWygrane szanse bez faktury ponad 7 dni od odbioru

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/naleznosci/do_wystawienia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/naleznosci/eksportEksport faktur dla ksiegowosci (csv, ifirma, wfirma)

Parametry

NazwaGdzieTypWymagany
formatzapytaniestringnie
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/naleznosci/eksport" \
  -H "Authorization: Bearer $KLUCZ"
get/api/naleznosci/jpkMiesieczne zestawienie sprzedazy z VAT pod JPK (json albo csv)

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie
formatzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/naleznosci/jpk" \
  -H "Authorization: Bearer $KLUCZ"
post/api/naleznosci/przypomnieniaPrzypomnienia o ratach: zadania i szkice maili, nic nie wysyla

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/naleznosci/przypomnienia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/oferty/statystykaLejek ofert i skutecznosc per usluga

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/oferty/statystyka" \
  -H "Authorization: Bearer $KLUCZ"
get/api/rabatyProsby o rabat do decyzji

Parametry

NazwaGdzieTypWymagany
stanzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/rabaty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/rabatyDecyzja wlasciciela o rabacie

Ciało (JSON)

PoleTypOpis
akcjastring
idinteger
uwagastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/rabaty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "id": ..., "uwaga": ...}'

Onboarding kroki

get/api/onboarding_krokiOnboarding w 5 krokach: poczta, import leadow, etapy, zespol, pierwsza oferta (liczone z faktow)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/onboarding_kroki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/onboarding_kroki/potwierdzReczne potwierdzenie kroku onboardingu

Ciało (JSON)

PoleTypOpis
krokstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/onboarding_kroki/potwierdz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"krok": ...}'

Opinie

get/api/opinieOpinie po odbiorze: skutecznosc prosb (cel 50% odpowiedzi) i referencje czekajace na decyzje

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/opinie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/opinie/npsNPS wg uslugi, wykonawcy i kanalu pozyskania

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/opinie/nps" \
  -H "Authorization: Bearer $KLUCZ"
post/api/opinie/poprosUruchom od reki prosby o opinie, przypomnienia i prosby o polecenie (szkice w kolejce poczty)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/opinie/popros" \
  -H "Authorization: Bearer $KLUCZ"
get/api/opinie/publicznebez kluczaZatwierdzone opinie klientow (publiczne, bez logowania)

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X GET "$CRM/api/opinie/publiczne"
get/api/opinie/referencjeOpinie 9-10 ze zgoda na cytat do publikacji jako referencje

Parametry

NazwaGdzieTypWymagany
stanzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/opinie/referencje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/opinie/referencje/odrzucOdrzuc opinie z publikacji

Ciało (JSON)

PoleTypOpis
ankietainteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/opinie/referencje/odrzuc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ankieta": ...}'
post/api/opinie/referencje/zatwierdzZatwierdz opinie do publikacji (oferta i strona)

Ciało (JSON)

PoleTypOpis
ankietainteger
podpisstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/opinie/referencje/zatwierdz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ankieta": ..., "podpis": ...}'

Osoby

get/api/osobyLista osob

Zakres klucza: moduł szanse, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/osoby" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "ile": 1,
  "osoby": [
    {
      "id": 4,
      "imie": "Jan",
      "nazwisko": "Kowalski",
      "imie_nazwisko": "Jan Kowalski",
      "email": "jan@acme.pl",
      "organizacja_id": 2
    }
  ]
}
post/api/osobyNowa osoba (znana po e-mailu zwraca te osobe)

Zakres klucza: moduł szanse, tryb zapis.

Ciało (JSON)

PoleTypOpis
imiestring
nazwiskostring
stanowiskostring
emailstring
telefonstring
organizacja_idinteger
notatkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/osoby" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"imie": "Jan", "nazwisko": "Kowalski", "email": "jan@acme.pl"}'

Przykładowa odpowiedź

{
  "ok": true,
  "nowa": true,
  "osoba": {
    "id": 4,
    "imie": "Jan",
    "nazwisko": "Kowalski",
    "imie_nazwisko": "Jan Kowalski",
    "email": "jan@acme.pl",
    "organizacja_id": 2
  }
}
get/api/osoby/propozycjePropozycje scalenia podobnych osob

Zakres klucza: moduł szanse, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/osoby/propozycje" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "propozycje": []
}
post/api/osoby/wizytowkaWizytowka (OCR obrazu albo tekst) jako nowa osoba

Ciało (JSON)

PoleTypOpis
obrazstring
tekststring
lead_idinteger
zapiszboolean
firma_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/osoby/wizytowka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"obraz": ..., "tekst": ..., "lead_id": ...}'
get/api/osoby/{id}Osoba z firma i szansami (id osoby)

Zakres klucza: moduł szanse, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/osoby/123" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "osoba": {
    "id": 4,
    "imie": "Jan",
    "nazwisko": "Kowalski",
    "imie_nazwisko": "Jan Kowalski",
    "email": "jan@acme.pl",
    "organizacja_id": 2
  }
}
put/api/osoby/{id}Czesciowa edycja osoby (id osoby)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
imiestring
nazwiskostring
stanowiskostring
emailstring
telefonstring
organizacja_idinteger
notatkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PUT "$CRM/api/osoby/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"telefon": "+48600100200"}'

Przykładowa odpowiedź

{
  "ok": true,
  "osoba": {
    "id": 4,
    "imie": "Jan",
    "nazwisko": "Kowalski",
    "imie_nazwisko": "Jan Kowalski",
    "email": "jan@acme.pl",
    "organizacja_id": 2
  }
}
post/api/osoby/{id}/scalScalenie drugiej osoby w te

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
zintegerId rekordu, ktory zostaje wchloniety

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/osoby/123/scal" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"z": 5}'

Przykładowa odpowiedź

{
  "ok": true,
  "osoba": {
    "id": 4,
    "imie": "Jan",
    "nazwisko": "Kowalski",
    "imie_nazwisko": "Jan Kowalski",
    "email": "jan@acme.pl",
    "organizacja_id": 2
  }
}

Ostatnie

get/api/ostatnieOstatnio otwierane karty konta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/ostatnie" \
  -H "Authorization: Bearer $KLUCZ"

Pakiet-startowy

get/api/pakiet-startowyOdpowiedzi startowych odczytow panelu w jednym zapytaniu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/pakiet-startowy" \
  -H "Authorization: Bearer $KLUCZ"

Passkey

get/api/passkeyKlucze dostepu (passkeys) zalogowanego konta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/passkey" \
  -H "Authorization: Bearer $KLUCZ"
post/api/passkey/logowanieLogowanie kluczem dostepu na ciasteczko sesji

Ciało (JSON)

PoleTypOpis
poswiadczenieobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/passkey/logowanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"poswiadczenie": ...}'
post/api/passkey/logowanie/opcjeOpcje WebAuthn do logowania (login opcjonalny), bez uwierzytelnienia

Ciało (JSON)

PoleTypOpis
loginstring

Odpowiedzi

  • 200 OK
  • 400 Zły format żądania
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/passkey/logowanie/opcje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ...}'
post/api/passkey/rejestracjaZapis klucza dostepu z wyniku navigator.credentials.create

Ciało (JSON)

PoleTypOpis
poswiadczenieobject
nazwastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/passkey/rejestracja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"poswiadczenie": ..., "nazwa": ...}'
post/api/passkey/rejestracja/opcjeOpcje WebAuthn do dodania klucza dostepu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/passkey/rejestracja/opcje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/passkey/usunUsuniecie klucza dostepu konta

Ciało (JSON)

PoleTypOpis
idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/passkey/usun" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ...}'

Plan

get/api/planPlan instancji: nazwa, limit i zuzycie kont, koniec okresu, ostrzezenie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/plan" \
  -H "Authorization: Bearer $KLUCZ"
post/api/plan/doplataWlasciciel potwierdza doplate za wieksza liczbe miejsc (kont) ponad oplacony pakiet

Ciało (JSON)

PoleTypOpis
miejscainteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/plan/doplata" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miejsca": ...}'

Platnosci

get/api/platnosci/dsoDSO i skutecznosc przypomnien o platnosci

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/platnosci/dso" \
  -H "Authorization: Bearer $KLUCZ"
get/api/platnosci/prognozaPrognoza wplywow rat i abonamentow na 30 dni

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/platnosci/prognoza" \
  -H "Authorization: Bearer $KLUCZ"
get/api/platnosci/prowizjeProwizje niewyplacone ponad 45 dni (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/platnosci/prowizje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/platnosci/prowizjePrzypomnienia o zaleglych prowizjach: zadania i powiadomienia (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/platnosci/prowizje" \
  -H "Authorization: Bearer $KLUCZ"
get/api/platnosci/raportNaleznosci z czesciowymi wplatami, nadplatami i kontrola sum

Parametry

NazwaGdzieTypWymagany
na_dzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/platnosci/raport" \
  -H "Authorization: Bearer $KLUCZ"
get/api/platnosci/wezwaniaWezwania do zaplaty czekajace na akceptacje (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/platnosci/wezwania" \
  -H "Authorization: Bearer $KLUCZ"
post/api/platnosci/wezwania/{id}/odrzucOdrzucenie wezwania do zaplaty (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/platnosci/wezwania/123/odrzuc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/platnosci/wezwania/{id}/zatwierdzAkceptacja wezwania: szkic maila w kolejce poczty (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/platnosci/wezwania/123/zatwierdz" \
  -H "Authorization: Bearer $KLUCZ"
get/api/platnosci/wplatyWplywy z banku i skutecznosc rozpoznawania (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
stanzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/platnosci/wplaty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/platnosci/wplatyImport wyciagu CSV: parowanie wplat z ratami (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/platnosci/wplaty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/platnosci/wplaty/{id}/dopasujReczne dopasowanie wplaty do raty (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/platnosci/wplaty/123/dopasuj" \
  -H "Authorization: Bearer $KLUCZ"
post/api/platnosci/zwrotZwrot wplaty raty z korekta faktury (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/platnosci/zwrot" \
  -H "Authorization: Bearer $KLUCZ"

Pliki

get/api/pliki/{id}Bajty pliku szansy albo wiadomosci zespolu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/pliki/123" \
  -H "Authorization: Bearer $KLUCZ"
delete/api/pliki/{id}Usuniecie pliku (autor albo wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X DELETE "$CRM/api/pliki/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/pliki/{id}/transkrypcjaReczna transkrypcja nagrania

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tekststring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/pliki/123/transkrypcja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ...}'

Po wygranej

get/api/po_wygranej/dziennikDziennik zmian kwot, terminow i nabywcy po wygranej

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/dziennik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/po_wygranej/etapyEtapy po wygranej wg trybu instancji (zwykly albo posrednik kredytowy)

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/etapy" \
  -H "Authorization: Bearer $KLUCZ"
get/api/po_wygranej/kopiaStan kopii dokumentow i ostatniego testu odtworzenia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/kopia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/po_wygranej/kopiaWykonuje kopie dokumentow i test odtworzenia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/po_wygranej/kopia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/po_wygranej/nabywcaNabywca zapisany przy wygranej po sprawdzeniu w KRS/CEIDG

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/nabywca" \
  -H "Authorization: Bearer $KLUCZ"
post/api/po_wygranej/nabywcaSprawdza nabywce wygranej w KRS/CEIDG i zapisuje roznice z oferta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/po_wygranej/nabywca" \
  -H "Authorization: Bearer $KLUCZ"
get/api/po_wygranej/niespojnosciNiespojnosci statusu wygranej z umowa, projektem, rata i faktura (cel 0)

Parametry

NazwaGdzieTypWymagany
testowezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/niespojnosci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/po_wygranej/proforma_duplikatOstrzezenie przed druga proforma na te sama szanse i rate

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie
rata_idzapytaniestringnie
nettozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/proforma_duplikat" \
  -H "Authorization: Bearer $KLUCZ"
get/api/po_wygranej/uzgodnienieMiesieczne uzgodnienie przychodu CRM z wplywami z banku

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/uzgodnienie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/po_wygranej/uzgodnienieImport wyciagu bankowego CSV (wplywy od klientow)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/po_wygranej/uzgodnienie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/po_wygranej/uzupelnienieBraki wygranej szansy i propozycja uzupelnienia wstecznego

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/po_wygranej/uzupelnienie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/po_wygranej/uzupelnienieDopina wstecznie kwote, usluge, umowe, projekt i harmonogram wygranej szansy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/po_wygranej/uzupelnienie" \
  -H "Authorization: Bearer $KLUCZ"

Poczta

get/api/poczta/adresaciOsoby szansy z adresem e-mail i domyslne Do oraz DW maila (osoba glowna, decydenci)

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/adresaci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/poczta/czas_wysylkiCzas od akceptacji do wysylki: mediana, p95 i odsetek ponizej 60 s (cel 95%) dla poczty i odpowiedzi Meta

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/czas_wysylki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/poczta/dnsKontrola SPF, DKIM i DMARC domeny nadawcy (zapytania DNS) z czytelnymi uwagami; nadawcy=1 sprawdza wszystkie domeny nadawcze (wynik pass albo fail)

Parametry

NazwaGdzieTypWymagany
domenazapytaniestringnie
nadawcyzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/poczta/dns" \
  -H "Authorization: Bearer $KLUCZ"
get/api/poczta/dostarczalnoscRaport dostarczalnosci: wyslane, odbicia twarde i miekkie, autorespondery, wypisy, wg dni i nadawcow

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/dostarczalnosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/poczta/nadawcaSkrzynki autora do wyboru na karcie leada i domyslna zgodna z ostatnia wiadomoscia klienta

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/nadawca" \
  -H "Authorization: Bearer $KLUCZ"
post/api/poczta/podgladPodglad maila (HTML, tekst, nadawca, zalaczniki) bez zapisu

Ciało (JSON)

PoleTypOpis
lead_idinteger
tematstring
trescstring
szablonstring
zalacznikiarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/poczta/podglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "temat": ..., "tresc": ...}'
get/api/poczta/profilProfil nadawcy i podpis (HTML i tekst) wlasny albo wskazany loginem (wlasciciel)

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/profil" \
  -H "Authorization: Bearer $KLUCZ"
put/api/poczta/profilZapis adresu nadawcy, nazwy i podpisu (HTML czyszczony, tekst wyliczany z drugiej wersji)

Ciało (JSON)

PoleTypOpis
loginstring
adres_odstring
nazwa_odstring
podpis_htmlstring
podpis_tekststring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/poczta/profil" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "adres_od": ..., "nazwa_od": ...}'
get/api/poczta/skrzynkiSkrzynki pocztowe uzytkownika (wlasciciel: wszystkie)

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/skrzynki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/poczta/skrzynkiNowa skrzynka uzytkownika: adres, odbior (IMAP albo Graph), wysylka (SMTP)

Ciało (JSON)

PoleTypOpis
adresstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/poczta/skrzynki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"adres": ...}'
post/api/poczta/skrzynki/{numer}Zmiana albo usuniecie skrzynki; domyslna: true przestawia skrzynke domyslna

Ciało (JSON)

PoleTypOpis
etykietastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/poczta/skrzynki/<numer>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"etykieta": ...}'
post/api/poczta/skrzynki/{numer}/testProba logowania do skrzynki bez pobierania poczty

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/poczta/skrzynki/<numer>/test" \
  -H "Authorization: Bearer $KLUCZ"
post/api/poczta/szkicSzkic odpowiedzi do klienta modelem w wybranym tonie (formalny, przyjazny, zwiezly, stanowczy, sprzedazowy); nic nie wysyla ani nie zapisuje

Ciało (JSON)

PoleTypOpis
lead_idinteger
tonstring
wskazowkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/poczta/szkic" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "ton": ..., "wskazowka": ...}'
post/api/poczta/tlumaczTlumaczenie tresci maila modelem przed wysylka (en, de, fr, es, it, uk, pl); nic nie zapisuje

Ciało (JSON)

PoleTypOpis
tekststring
jezykstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/poczta/tlumacz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "jezyk": ...}'
get/api/poczta/watek_kontrolaMaile wyslane z CRM w trakcie rozmowy bez In-Reply-To (cel: 0 nowych watkow w rozmowie)

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/watek_kontrola" \
  -H "Authorization: Bearer $KLUCZ"
get/api/poczta/wychodzaceKolejka maili wychodzacych z CRM (szkic, zaplanowana, wyslana, blad, odrzucona)

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie
stanzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/poczta/wychodzace" \
  -H "Authorization: Bearer $KLUCZ"
post/api/poczta/wychodzaceNowy mail z CRM: szablon HTML z logo i stopka, podpis, zalaczniki (oferta PDF, biblioteka, wgrany plik); wyslij=true wysyla od razu, zaplanowano=RRRR-MM-DDTGG:MM ustawia godzine, inaczej szkic

Ciało (JSON)

PoleTypOpis
lead_idinteger
dostring
tematstring
trescstring
szablonstring
zalacznikiarray
zaplanowanostring
wyslijboolean
bez_podpisuboolean
mimo_blokadyboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/poczta/wychodzace" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead_id": ..., "do": ..., "temat": ...}'
post/api/poczta/wychodzace/{id}Decyzja o mailu z kolejki CRM: akcja wyslij, odrzuc albo zaplanuj (+ zaplanowano)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring
zaplanowanostring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/poczta/wychodzace/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "zaplanowano": ...}'

Podglad

post/api/podgladPodglad CRM oczami innego konta, tylko odczyt (tylko wlasciciel; pusty login konczy)

Ciało (JSON)

PoleTypOpis
loginstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/podglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ...}'

Polaczenia

get/api/polaczeniaPolaczenia poczty i kalendarza (Google, Microsoft, IMAP) ze stanem zgody

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/polaczenia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/polaczenia/google/startAdres ekranu zgody Google (poczta, kalendarz albo oba)

Parametry

NazwaGdzieTypWymagany
celzapytaniestringnie
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/polaczenia/google/start" \
  -H "Authorization: Bearer $KLUCZ"
get/api/polaczenia/microsoft/startAdres ekranu zgody Microsoft 365 (poczta, kalendarz albo oba)

Parametry

NazwaGdzieTypWymagany
celzapytaniestringnie
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/polaczenia/microsoft/start" \
  -H "Authorization: Bearer $KLUCZ"
get/api/polaczenia/microsoft/zgoda-adminaAdres zgody administratora tenanta Microsoft 365

Parametry

NazwaGdzieTypWymagany
tenantzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/polaczenia/microsoft/zgoda-admina" \
  -H "Authorization: Bearer $KLUCZ"
post/api/polaczenia/odlaczOdlaczenie kalendarza OAuth

Ciało (JSON)

PoleTypOpis
kluczstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/polaczenia/odlacz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klucz": ...}'

Polecenia

get/api/poleceniaProgram polecen: polecajacy z liczba poleconych szans, wygranych i wartoscia wygranych, od najwyzszej wartosci

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/polecenia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/polecenia/rejestrRejestr polecen: polecajacy, polecona szansa, stan, wartosc, nagroda i kod

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/polecenia/rejestr" \
  -H "Authorization: Bearer $KLUCZ"
post/api/polecenia/ustawUstaw, kto polecil szanse (numer szansy polecajacego; pusty zdejmuje)

Ciało (JSON)

PoleTypOpis
leadinteger
polecilinteger

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/polecenia/ustaw" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lead": ..., "polecil": ...}'

Pomiar

post/api/pomiar/kliknieciaSumy klikniec w panelu po identyfikatorze przycisku (bez tresci formularzy); ranking w GET /api/zdrowie (klikniecia_panelu)

Ciało (JSON)

PoleTypOpis
kliknieciaobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/pomiar/klikniecia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klikniecia": ...}'
post/api/pomiar/panelCore Web Vitals panelu z przegladarki uzytkownika: lcp, inp, cls, fcp, ttfb (ms; cls bez jednostki), szerokosc okna; podsumowanie p75 w GET /api/zdrowie (web_vitals)

Ciało (JSON)

PoleTypOpis
lcpnumber
inpnumber
clsnumber
fcpnumber
ttfbnumber
szerokoscnumber

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/pomiar/panel" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lcp": ..., "inp": ..., "cls": ...}'

Pomoc

post/api/pomoc/czatCzat wsparcia w panelu: odpowiedz z bazy wiedzy albo uwaga do opiekuna wdrozenia

Ciało (JSON)

PoleTypOpis
pytaniestring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/pomoc/czat" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"pytanie": ...}'

Porzadki

get/api/porzadkiPorzadki: propozycje sprzatania danych (duplikaty, szanse bez ruchu, braki pol, szanse bez opiekuna) z licznikami

Parametry

NazwaGdzieTypWymagany
rodzajzapytaniestringnie
stanzapytaniestringnie
limitzapytaniestringnie
offsetzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/porzadki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/porzadki/cofnijCofniecie zaakceptowanej propozycji Porzadkow z kopii

Ciało (JSON)

PoleTypOpis
idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/porzadki/cofnij" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ...}'
post/api/porzadki/decyzjaAkceptacja albo odrzucenie propozycji Porzadkow: ids albo rodzaj; akceptacja robi kopie i wpis w audycie

Ciało (JSON)

PoleTypOpis
decyzjastring
idsarray
rodzajstring
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/porzadki/decyzja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"decyzja": ..., "ids": ..., "rodzaj": ...}'
get/api/porzadki/licznikLiczba oczekujacych propozycji Porzadkow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/porzadki/licznik" \
  -H "Authorization: Bearer $KLUCZ"
post/api/porzadki/przebiegZebranie propozycji Porzadkow teraz (nic nie zmienia danych)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 409 Konflikt

Przykład

curl -sS -X POST "$CRM/api/porzadki/przebieg" \
  -H "Authorization: Bearer $KLUCZ"

Pozyskiwanie

get/api/pozyskiwanieStan pozyskiwania leadów per kanał (Messenger, Instagram, poczta, portale, formularz): kropka z faktów (usługi, importy, ostatni lead i wiadomość klienta)

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/pozyskiwanie" \
  -H "Authorization: Bearer $KLUCZ"

Praca

post/api/praca/celeMiesieczne cele zespolu: wygrane i wartosc (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
wygraneinteger
wartoscnumber

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/cele" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wygrane": ..., "wartosc": ...}'
get/api/praca/coachingPrzyklady dobrych odpowiedzi z wygranych szans

Parametry

NazwaGdzieTypWymagany
autorzapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/praca/coaching" \
  -H "Authorization: Bearer $KLUCZ"
post/api/praca/dyzurPrzekazanie dyzuru dzwonkow innemu doradcy

Ciało (JSON)

PoleTypOpis
komustring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/dyzur" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"komu": ...}'
get/api/praca/godzinyGodziny pracy konta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/praca/godziny" \
  -H "Authorization: Bearer $KLUCZ"
post/api/praca/godzinyZapis godzin pracy konta (spojnych z dyzurem dzwonkow)

Ciało (JSON)

PoleTypOpis
godzinyobject
loginstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/godziny" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"godziny": ..., "login": ...}'
get/api/praca/grafikDyzury w kalendarzu: kto pracuje, kto nieobecny

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/praca/grafik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/praca/obciazenieRaport obciazenia zespolu zadaniami

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/praca/obciazenie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/praca/offboardingOdejscie handlowca: przekazanie szans i zadan (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
loginstring
przekaz_dostring
notatkastring
wylacz_kontoboolean
podgladboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/offboarding" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "przekaz_do": ..., "notatka": ...}'
get/api/praca/ogloszeniaTablica ogloszen zespolu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/praca/ogloszenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/praca/ogloszeniaNowe ogloszenie zespolu, trafia do skrzynek i push (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
trescstring
przypieteboolean
wygasastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/ogloszenia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ..., "przypiete": ..., "wygasa": ...}'
get/api/praca/onboardingChecklisty onboardingu handlowcow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/praca/onboarding" \
  -H "Authorization: Bearer $KLUCZ"
post/api/praca/onboardingStart i zmiany checklisty onboardingu (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
akcjastring
loginstring
idinteger
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/onboarding" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "login": ..., "id": ...}'
get/api/praca/rankingRanking zespolu za miesiac z postepem do celow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/praca/ranking" \
  -H "Authorization: Bearer $KLUCZ"
get/api/praca/skrzynkaPowiadomienia zespolu zalogowanego

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/praca/skrzynka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/praca/skrzynkaOznaczenie powiadomien jako przeczytanych

Ciało (JSON)

PoleTypOpis
idinteger
wszystkieboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/skrzynka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "wszystkie": ...}'
get/api/praca/statystykiStatystyki per osoba (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/praca/statystyki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/praca/szablonySzablony zadan per etap

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/praca/szablony" \
  -H "Authorization: Bearer $KLUCZ"
post/api/praca/szablonyNowy szablon zadan per etap (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
wyzwalaczstring
trescstring
dniinteger
priorytetinteger
pozycjearray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/praca/szablony" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wyzwalacz": ..., "tresc": ..., "dni": ...}'
get/api/praca/szukajSzukanie w komentarzach, notatkach i zadaniach

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/praca/szukaj" \
  -H "Authorization: Bearer $KLUCZ"
get/api/praca/widokWidok dnia albo tygodnia: zadania osoby i zalegle

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/praca/widok" \
  -H "Authorization: Bearer $KLUCZ"

Preferencje

get/api/preferencjeZapamietane ustawienia panelu konta (uklad kolumn, gestosc listy)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/preferencje" \
  -H "Authorization: Bearer $KLUCZ"
put/api/preferencjeZapis ustawien panelu konta: klucze (tekst) i usun (lista)

Ciało (JSON)

PoleTypOpis
kluczeobject
usunarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/preferencje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klucze": ..., "usun": ...}'

Probna

get/api/probnaOkres probny instancji: do kiedy, ile dni zostalo i czy panel jest juz tylko do odczytu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/probna" \
  -H "Authorization: Bearer $KLUCZ"

Projekty

get/api/projektyWidok Projekty: wiersze z postepem, terminami, marza i sumy

Parametry

NazwaGdzieTypWymagany
statuszapytaniestringnie
archiwumzapytaniestringnie
szukajzapytaniestringnie
opiekunzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/projekty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/projekty/przypomnieniaZadania o terminach projektow (kamienie, raty, abonamenty, gwarancja, SLA)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/projekty/przypomnienia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/projekty/szablonySzablony projektow per usluga i szablon standardowy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/projekty/szablony" \
  -H "Authorization: Bearer $KLUCZ"
post/api/projekty/szablonyNowy szablon projektu (kamienie z terminem w % czasu, waga, % raty)

Ciało (JSON)

PoleTypOpis
nazwastring
katalog_idinteger
kamieniearray

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/projekty/szablony" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "katalog_id": ..., "kamienie": ...}'
get/api/projekty/zadania_agentaOtwarte zadania realizacji jako polecenia dla agentow Fluxdesku

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/projekty/zadania_agenta" \
  -H "Authorization: Bearer $KLUCZ"

Przypiecia

post/api/przypiecia/cofnijCofnij przypiecie watku

Ciało (JSON)

PoleTypOpis
idinteger

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/przypiecia/cofnij" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ...}'
post/api/przypiecia/przypnijPrzypnij watek do innego leada: zdarzenia, klucz nadawcy, audyt, dane do cofniecia

Ciało (JSON)

PoleTypOpis
zinteger
dointeger

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/przypiecia/przypnij" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"z": ..., "do": ...}'
get/api/przypiecia/regulyReguly przypinania nadawcy (domena, adres, numer, klucz zrodla) i przypiecia reczne

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/przypiecia/reguly" \
  -H "Authorization: Bearer $KLUCZ"
post/api/przypiecia/regulyDodaje regule przypinania nadawcy do leada albo firmy

Ciało (JSON)

PoleTypOpis
typstring
wartoscstring
lead_idinteger
firmastring

Odpowiedzi

  • 201 Utworzono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/przypiecia/reguly" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"typ": ..., "wartosc": ..., "lead_id": ...}'
get/api/przypiecia/ruchyPrzypiecia dotyczace leada, ktorych nie cofnieto

Parametry

NazwaGdzieTypWymagany
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/przypiecia/ruchy" \
  -H "Authorization: Bearer $KLUCZ"
get/api/przypiecia/szukajSzukanie leadow jako celu przypiecia (nazwa, firma, e-mail, numer)

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie
bezzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/przypiecia/szukaj" \
  -H "Authorization: Bearer $KLUCZ"

Raporty

get/api/raporty/handlowiecRaport tygodniowy handlowca na telefon bez kosztow (HTML albo format=json); osoba= tylko wlasciciel

Parametry

NazwaGdzieTypWymagany
osobazapytaniestringnie
formatzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/raporty/handlowiec" \
  -H "Authorization: Bearer $KLUCZ"
get/api/raporty/zarzadLista raportow tygodniowych zarzadu (piatek-czwartek), generowanych automatycznie w piatek o 8:00 (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/raporty/zarzad" \
  -H "Authorization: Bearer $KLUCZ"
get/api/raporty/zarzad/{dzien}Pobranie raportu zarzadu z piatku RRRR-MM-DD (PDF albo HTML) (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/raporty/zarzad/<dzien>" \
  -H "Authorization: Bearer $KLUCZ"

Raporty z widoków

get/api/raporty-widokowRaporty z zapisanych widokow (bez wierszy) i widoki z harmonogramem zalogowanego uzytkownika

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/raporty-widokow" \
  -H "Authorization: Bearer $KLUCZ"
post/api/raporty-widokow/generujRaport zapisanego widoku teraz

Ciało (JSON)

PoleTypOpis
widok_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/raporty-widokow/generuj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"widok_id": ...}'
post/api/raporty-widokow/harmonogramHarmonogram raportu widoku: dzien, tydzien:0-6, miesiac:1-28 albo pusty (wylacza)

Ciało (JSON)

PoleTypOpis
widok_idinteger
harmonogramstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/raporty-widokow/harmonogram" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"widok_id": ..., "harmonogram": ...}'
get/api/raporty-widokow/listaPlik biezacej listy wg filtrow widoku (dane = JSON widoku): csv, xlsx albo pdf

Parametry

NazwaGdzieTypWymagany
formatzapytaniestringnie
danezapytaniestringnie
nazwazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/raporty-widokow/lista" \
  -H "Authorization: Bearer $KLUCZ"
get/api/raporty-widokow/{id}Pelny raport widoku: kolumny, wiersze, podsumowanie i zmiany wzgledem poprzedniego

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/raporty-widokow/123" \
  -H "Authorization: Bearer $KLUCZ"
delete/api/raporty-widokow/{id}Usuniecie raportu widoku

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/raporty-widokow/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/raporty-widokow/{id}/eksportPlik raportu widoku: csv, xlsx albo pdf

Parametry

NazwaGdzieTypWymagany
idadresintegertak
formatzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/raporty-widokow/123/eksport" \
  -H "Authorization: Bearer $KLUCZ"

Realizacja

get/api/realizacjaPrzegląd realizacji: lejek projektów, wygrane bez projektu, zastój, przeciążenia, mediany startu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/realizacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/realizacja/cyklUruchamia cykl realizacji (projekty z wygranych, przypomnienia, odbiory milczące, dopłaty)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/realizacja/cykl" \
  -H "Authorization: Bearer $KLUCZ"
post/api/realizacja/{id}/doplaty/{did}Decyzja o dopłacie (akceptuj tworzy ratę, odrzuć zamyka propozycję)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
didadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring
kwota_nettonumber

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/realizacja/123/doplaty/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "kwota_netto": ...}'
get/api/realizacja/{id}/dostepyDostępy i pliki oczekiwane od klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/realizacja/123/dostepy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/realizacja/{id}/dostepyDodaje dostęp albo plik oczekiwany od klienta (blokuje kamień)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
rodzajstring
kamien_idinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/realizacja/123/dostepy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "rodzaj": ..., "kamien_id": ...}'
post/api/realizacja/{id}/dostepy/{did}Oznacza dostęp jako dostarczony albo brakujący

Parametry

NazwaGdzieTypWymagany
idadresintegertak
didadresintegertak

Ciało (JSON)

PoleTypOpis
stanstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/realizacja/123/dostepy/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"stan": ...}'
post/api/realizacja/{id}/gotowoscZgłoszenie gotowości do odbioru ze szkicem do klienta i opcją odbioru milczącego

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
odbior_milczacyboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/realizacja/123/gotowosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"odbior_milczacy": ...}'
post/api/realizacja/{id}/opiniaSzkic prośby o opinię po zakończeniu projektu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/realizacja/123/opinia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/realizacja/{id}/raportSzkic raportu postępu projektu dla klienta (kamienie i godziny)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/realizacja/123/raport" \
  -H "Authorization: Bearer $KLUCZ"

Reguły automatyczne

get/api/regulyReguly automatyczne: z pliku konfiguracji (tylko odczyt) i z panelu, katalog warunkow, akcji i wzorcow, ostatni dziennik

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/reguly" \
  -H "Authorization: Bearer $KLUCZ"
post/api/regulyNowa regula z panelu (warunek z listy + parametry, akcja z listy); domyslnie nieaktywna, tylko wlasciciel

Ciało (JSON)

PoleTypOpis
nazwastring
warunekstring
warunek_parametryobject
akcjastring
parametryobject
aktywnaboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/reguly" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "warunek": ..., "warunek_parametry": ...}'
post/api/reguly/testTest reguly na historii: co by odpalila w ostatnich N dniach (id, wzorzec albo regula; na sucho, nic nie wykonuje)

Ciało (JSON)

PoleTypOpis
idinteger
wzorzecstring
regulaobject
dniinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/reguly/test" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "wzorzec": ..., "regula": ...}'
put/api/reguly/{id}Zmiana reguly z panelu, takze wlaczenie i wylaczenie (aktywna)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
warunekstring
warunek_parametryobject
akcjastring
parametryobject
aktywnaboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/reguly/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "warunek": ..., "warunek_parametry": ...}'
delete/api/reguly/{id}Usuniecie reguly z panelu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/reguly/123" \
  -H "Authorization: Bearer $KLUCZ"

Reklamacje

get/api/reklamacjeSprawy klientow po sprzedazy (reklamacje, zapytania, serwis) z filtrem statusu i terminu

Parametry

NazwaGdzieTypWymagany
statuszapytaniestringnie
terminzapytaniestringnie
rodzajzapytaniestringnie
leadzapytaniestringnie
organizacjazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/reklamacje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/reklamacjeNowa sprawa klienta (R-0001) powiazana z szansa, firma lub osoba albo z mailem szansy

Ciało (JSON)

PoleTypOpis
rodzajstring
opisstring
leadinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/reklamacje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "opis": ..., "lead": ...}'
get/api/reklamacje/{numer}Sprawa klienta z historia zmian

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/reklamacje/<numer>" \
  -H "Authorization: Bearer $KLUCZ"
post/api/reklamacje/{numer}Zmiana statusu, opiekuna, terminu, priorytetu albo notatka (kazda w historii)

Ciało (JSON)

PoleTypOpis
statusstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/reklamacje/<numer>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"status": ...}'
post/api/reklamacje/{numer}/odpowiedzSzkic maila do klienta w kolejce poczty (wysyla czlowiek po akceptacji)

Ciało (JSON)

PoleTypOpis
tematstring
trescstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/reklamacje/<numer>/odpowiedz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"temat": ..., "tresc": ...}'

Relacje

get/api/relacje/studiaStudia przypadku z projektow (szkic, zgoda klienta, publikacja)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/relacje/studia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/relacje/studiumSzkic studium przypadku z projektu: problem, rozwiazanie, wynik

Ciało (JSON)

PoleTypOpis
projektinteger

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/relacje/studium" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"projekt": ...}'
post/api/relacje/studium/publikujOpublikuj studium przypadku (tylko po zapisanej zgodzie klienta)

Ciało (JSON)

PoleTypOpis
idinteger

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/relacje/studium/publikuj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ...}'
post/api/relacje/studium/szkicSzkic maila z prosba o zgode na studium (kolejka akceptacji)

Ciało (JSON)

PoleTypOpis
idinteger

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/relacje/studium/szkic" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ...}'
post/api/relacje/studium/zgodaZapisz zgode klienta na publikacje studium (kto i dowod)

Ciało (JSON)

PoleTypOpis
idinteger
ktostring
dowodstring

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/relacje/studium/zgoda" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "kto": ..., "dowod": ...}'
post/api/relacje/uruchomCykl relacji po sprzedazy: opinie, polecenia, kontrola 30 dni, dosprzedaz, zagrozeni, reklamacje bez decyzji

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/relacje/uruchom" \
  -H "Authorization: Bearer $KLUCZ"

Rodo

get/api/rodo/rejestr_czynnosciRejestr czynnosci przetwarzania z konfiguracji instancji, format json, html albo pdf (tylko klucz pelny albo wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/rodo/rejestr_czynnosci" \
  -H "Authorization: Bearer $KLUCZ"
get/api/rodo/wnioskiDziennik zadan RODO: data zadania, termin 30 dni, wykonanie (tylko klucz pelny albo wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/rodo/wnioski" \
  -H "Authorization: Bearer $KLUCZ"

Role kont

get/api/role_kontRole wlasne kont z uprawnieniami per modul (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/role_kont" \
  -H "Authorization: Bearer $KLUCZ"
post/api/role_kontRola wlasna: akcja zapisz (nazwa, baza, uprawnienia), usun albo przypisz do konta

Ciało (JSON)

PoleTypOpis
akcjastring
nazwastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/role_kont" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "nazwa": ...}'

Role macierz

get/api/role_macierzMacierz uprawnien modul x rola; z ?jako=login podglad, co zobaczy to konto (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
jakozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/role_macierz" \
  -H "Authorization: Bearer $KLUCZ"

Role osób w szansie

get/api/roleRole osob przy szansie (slownik)

Zakres klucza: moduł szanse, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/role" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "role": [
    {
      "klucz": "szef",
      "nazwa": "Szef"
    }
  ]
}
put/api/rolePodmiana slownika rol osob

Zakres klucza: moduł szanse, tryb zapis.

Ciało (JSON)

PoleTypOpis
rolearray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PUT "$CRM/api/role" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"role": [{"klucz": "szef", "nazwa": "Szef"}]}'

Przykładowa odpowiedź

{
  "ok": true
}

Rozmowy

post/api/rozmowy/wygasKasowanie nagran starszych niz retencja [glos] (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/rozmowy/wygas" \
  -H "Authorization: Bearer $KLUCZ"
get/api/rozmowy/{id}/audioBajty nagrania rozmowy (wlasciciel i handlowiec)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/rozmowy/123/audio" \
  -H "Authorization: Bearer $KLUCZ"
post/api/rozmowy/{id}/transkrypcjaTranskrypcja rozmowy ze streszczeniem, nastrojem i slowami kluczowymi

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tekststring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/rozmowy/123/transkrypcja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ...}'
post/api/rozmowy/{id}/usunKasowanie audio i tekstu nagrania (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/rozmowy/123/usun" \
  -H "Authorization: Bearer $KLUCZ"

Rozmowy agentow

get/api/rozmowy_agentowWatek rozmowy z agentem (freelancing dla szansy albo crm); przeczytaj=1 oznacza odpowiedzi jako przeczytane

Parametry

NazwaGdzieTypWymagany
agentzapytaniestringnie
lead_idzapytaniestringnie
przeczytajzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/rozmowy_agentow" \
  -H "Authorization: Bearer $KLUCZ"
post/api/rozmowy_agentowPytanie do agenta (freelancing dla szansy albo crm); trafia do sesji Fluxdeska

Ciało (JSON)

PoleTypOpis
agentstring
lead_idinteger
trescstring

Odpowiedzi

  • 201 Utworzono
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/rozmowy_agentow" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"agent": ..., "lead_id": ..., "tresc": ...}'
get/api/rozmowy_agentow/nieprzeczytaneLiczba nieprzeczytanych odpowiedzi agentow (crm i per szansa)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/rozmowy_agentow/nieprzeczytane" \
  -H "Authorization: Bearer $KLUCZ"

Rynek

get/api/rynekFormaty regionalne (pl-PL, en-GB, en-US, uk-UA): kwota obok w PLN, EUR i USD po kursie NBP, data i telefon miedzynarodowy

Parametry

NazwaGdzieTypWymagany
kwotazapytaniestringnie
walutazapytaniestringnie
regionzapytaniestringnie
datazapytaniestringnie
telefonzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/rynek" \
  -H "Authorization: Bearer $KLUCZ"

Sesje

get/api/sesjeUrzadzenia zalogowane na koncie (sesje z IP i nazwa urzadzenia)

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/sesje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/sesje/wylogujZdalne wylogowanie: id sesji, inne (wszystkie poza biezaca) albo login (wlasciciel)

Ciało (JSON)

PoleTypOpis
idinteger
inneboolean
loginstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sesje/wyloguj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "inne": ..., "login": ...}'
post/api/sesje/wyloguj_wszystkichWylogowanie wszystkich uzytkownikow instancji (wlasciciel); wlacznie_ze_mna konczy tez biezaca sesje

Ciało (JSON)

PoleTypOpis
wlacznie_ze_mnaboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/sesje/wyloguj_wszystkich" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlacznie_ze_mna": ...}'

Skala

get/api/skalaOperator skali: przeglad floty, pojemnosci, miernikow i wsparcia (wlasciciel, tryb operatora)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/betaProgram beta: funkcje i uczestnicy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/beta" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/beta/{funkcja}Zapis funkcji beta

Ciało (JSON)

PoleTypOpis
tytulstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/beta/<funkcja>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ...}'
post/api/skala/beta/{funkcja}/zapisZapis klienta do programu beta funkcji

Ciało (JSON)

PoleTypOpis
klientstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/beta/<funkcja>/zapis" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klient": ...}'
get/api/skala/certyfikatyGotowosc do ISO 27001: kontrole, dowody w kodzie, luki

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/certyfikaty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/certyfikaty/{kontrola}Reczne potwierdzenie kontroli ISO 27001

Ciało (JSON)

PoleTypOpis
statusstring
dowodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/certyfikaty/<kontrola>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"status": ..., "dowod": ...}'
post/api/skala/cyklCykl dobowy: faktury biezacego miesiaca, zaleglosci, zamkniecie trialow

Ciało (JSON)

PoleTypOpis
stripeboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/cykl" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"stripe": ...}'
get/api/skala/dziennik/{klient}Dziennik zdarzen klienta: zakup, platnosci, karencja, anulowanie, eksport

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/dziennik/<klient>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/flotaRejestr instancji floty

Parametry

NazwaGdzieTypWymagany
statuszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/flota" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/flotaNowa instancja w rejestrze (planowana)

Ciało (JSON)

PoleTypOpis
klientstring
firmastring
domenastring
planstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/flota" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klient": ..., "firma": ..., "domena": ...}'
get/api/skala/flota/aktualizacjaPlan zbiorczej aktualizacji falami w oknie serwisowym

Parametry

NazwaGdzieTypWymagany
refzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/flota/aktualizacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/flota/manifestUzgodnienie rejestru z manifestem floty

Ciało (JSON)

PoleTypOpis
instancjearray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/flota/manifest" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"instancje": ...}'
get/api/skala/flota/pojemnoscZajetosc VPS i potrzeby na docelowa liczbe instancji

Parametry

NazwaGdzieTypWymagany
docelowozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/flota/pojemnosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/flota/skryptSkrypt zakladania planowanych instancji z limitami

Parametry

NazwaGdzieTypWymagany
refzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/flota/skrypt" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/flota/stanStan zywych instancji (odswiez=1 odpytuje /api/zdrowie)

Parametry

NazwaGdzieTypWymagany
odswiezzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/flota/stan" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/flota/{klient}Zmiana pol instancji

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/flota/<klient>" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/licencje/{klient}Licencje wg aktywnych kont instancji klienta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/licencje/<klient>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/materialy/newsletterSzkice newslettera Co nowego

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/materialy/newsletter" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/materialy/newsletterSzkic newslettera z notatek wydan

Ciało (JSON)

PoleTypOpis
odstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/materialy/newsletter" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"od": ...}'
post/api/skala/materialy/studiumStudium przypadku z raportu pilotazu klienta

Ciało (JSON)

PoleTypOpis
klientstring
branzastring
pilotazobject

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/materialy/studium" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klient": ..., "branza": ..., "pilotaz": ...}'
get/api/skala/materialy/wideoScenariusze wideo i szkolen

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/materialy/wideo" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/materialy/wideo/{klucz}Scenariusz wideo ze scenami i napisami SRT

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/materialy/wideo/<klucz>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/miernikiMRR, ARR, churn, LTV i NPS

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/mierniki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/mrrMRR, klienci i churn z wplat Stripe zestawione z umowami oraz konwersja prob

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/mrr" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/naleznosciJeden widok nieoplaconych proform i faktur

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/naleznosci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/ofertaOferta z jednego wzoru: abonament i wdrozenie pod klucz osobno, VAT wg nabywcy

Ciało (JSON)

PoleTypOpis
planstring
uzytkownicyinteger
nabywcaobject
wdrozenie_zlnumber

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/oferta" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"plan": ..., "uzytkownicy": ..., "nabywca": ...}'
get/api/skala/operacje/dyzurDziennik dyzuru: alerty, potwierdzenia, eskalacje

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/operacje/dyzur" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/operacje/dyzur/{numer}/potwierdzPotwierdzenie alertu (zatrzymuje eskalacje alarmem)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/operacje/dyzur/<numer>/potwierdz" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/operacje/incydentyPrzeglad miesiaca rejestru incydentow: liczba, czas, MTTR, brak przyczyny

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/operacje/incydenty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/operacje/incydenty/{numer}/opisPrzyczyna i poprawka incydentu

Ciało (JSON)

PoleTypOpis
przyczynastring
poprawkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/operacje/incydenty/<numer>/opis" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"przyczyna": ..., "poprawka": ...}'
get/api/skala/operacje/logiPrzeszukiwanie logow klienta bez ssh (klient, fraza, poziom, limit)

Parametry

NazwaGdzieTypWymagany
klientzapytaniestringnie
frazazapytaniestringnie
poziomzapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/operacje/logi" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/operacje/metrykiMetryki, progi alertow i zdrowie importow wszystkich instancji floty

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/operacje/metryki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/operacje/przegladOznaczenie przegladu incydentow miesiaca

Ciało (JSON)

PoleTypOpis
miesiacstring
uwagistring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/operacje/przeglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miesiac": ..., "uwagi": ...}'
get/api/skala/operacje/slaSLA miesieczne per instancja (cel 99,5 procent)

Parametry

NazwaGdzieTypWymagany
miesiaczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/operacje/sla" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/operacje/status-stronyPubliczna strona statusu (HTML w polu html)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/operacje/status-strony" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/operacje/tokenyRejestr tokenow z liczba dni do wygasniecia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/operacje/tokeny" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/operacje/tokenyRejestracja daty wygasniecia tokenu

Ciało (JSON)

PoleTypOpis
nazwastring
wygasastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/operacje/tokeny" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "wygasa": ...}'
get/api/skala/partnerzyPartnerzy wdrozeniowi i marka produktu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/partnerzy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/partnerzyNowy partner; klucz API widac raz

Ciało (JSON)

PoleTypOpis
kluczstring
nazwastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/partnerzy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klucz": ..., "nazwa": ...}'
get/api/skala/plan-finansowyPlan finansowy produktu na 24 miesiace i rekomendacja finansowania

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/plan-finansowy" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/planyPlany, dodatki, kraje, branze, integracje i wycena per liczba kont

Parametry

NazwaGdzieTypWymagany
planzapytaniestringnie
uzytkownicyzapytaniestringnie
dodatkizapytaniestringnie
okreszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/plany" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/platnosci/{klient}Sesja platnosci kartowej Stripe Checkout dla faktury albo subskrypcji

Ciało (JSON)

PoleTypOpis
fakturastring
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/platnosci/<klient>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"faktura": ..., "wyslij": ...}'
post/api/skala/portal/{klient}Link do portalu rozliczen Stripe klienta

Ciało (JSON)

PoleTypOpis
wyslijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/portal/<klient>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wyslij": ...}'
post/api/skala/przelewZaksiegowanie przelewu na proforme lub fakture

Ciało (JSON)

PoleTypOpis
numerstring
kwotanumber
datastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/przelew" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"numer": ..., "kwota": ..., "data": ...}'
post/api/skala/przelew/wyciagZaksiegowanie wierszy wyciagu po numerze PF/FS w tytule

Ciało (JSON)

PoleTypOpis
wierszearray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/przelew/wyciag" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wiersze": ...}'
get/api/skala/referencjeReferencje opublikowane za zgoda klienta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/referencje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/referencje/{klucz}Zapis referencji (wymaga zgoda: true)

Ciało (JSON)

PoleTypOpis
klientstring
cytatstring
ocenainteger
zgodaboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/referencje/<klucz>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klient": ..., "cytat": ..., "ocena": ...}'
get/api/skala/rejestracjaTriale 14-dniowe z dniami do konca

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/rejestracja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/rejestracjaRejestracja z trialem: instancja planowana i trial 14 dni

Ciało (JSON)

PoleTypOpis
firmastring
emailstring

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/rejestracja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"firma": ..., "email": ...}'
post/api/skala/rejestracja/{klient}/konwersjaKonwersja triala na abonament

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/rejestracja/<klient>/konwersja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/rejestracja/{klient}/zalozPlan zalozenia instancji; wykonaj: true uruchamia go przy [skala] provisioning

Ciało (JSON)

PoleTypOpis
wykonajboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/rejestracja/<klient>/zaloz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wykonaj": ...}'
get/api/skala/rozliczeniaAbonamenty, faktury i rezygnacje

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/rozliczenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/rozliczenia/abonament/{klient}Zawarcie albo zmiana abonamentu

Ciało (JSON)

PoleTypOpis
planstring
uzytkownicyinteger

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/rozliczenia/abonament/<klient>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"plan": ..., "uzytkownicy": ...}'
post/api/skala/rozliczenia/eksport/{klient}Pobranie eksportu danych wypowiadajacego klienta

Ciało (JSON)

PoleTypOpis
katalogstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/rozliczenia/eksport/<klient>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"katalog": ...}'
post/api/skala/rozliczenia/fakturyFaktury abonamentowe za miesiac RRRR-MM

Ciało (JSON)

PoleTypOpis
miesiacstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/rozliczenia/faktury" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miesiac": ...}'
post/api/skala/rozliczenia/rezygnacja/{klient}Rezygnacja z planem offboardingu

Ciało (JSON)

PoleTypOpis
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/rozliczenia/rezygnacja/<klient>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"powod": ...}'
get/api/skala/stronaHTML strony produktu

Parametry

NazwaGdzieTypWymagany
kontaktzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/strona" \
  -H "Authorization: Bearer $KLUCZ"
get/api/skala/wiedzaBaza wiedzy z wyszukiwarka

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/wiedza" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/wiedza/{klucz}Zapis artykulu bazy wiedzy

Ciało (JSON)

PoleTypOpis
tytulstring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/wiedza/<klucz>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "tresc": ...}'
get/api/skala/wsparcieZgloszenia wsparcia z SLA i statystykami

Parametry

NazwaGdzieTypWymagany
statuszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/skala/wsparcie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/wsparcieNowe zgloszenie; agent odpowiada z bazy wiedzy albo eskaluje

Ciało (JSON)

PoleTypOpis
tematstring
trescstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/wsparcie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"temat": ..., "tresc": ...}'
post/api/skala/wsparcie/eskalacjaAwans zgloszen po terminie SLA

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/wsparcie/eskalacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/skala/wsparcie/{id}Odpowiedz klienta albo czlowieka, rozwiazanie, nie_pomoglo

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/wsparcie/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
post/api/skala/zakupZakup na stronie: trial, abonament i sesja Stripe Checkout (karta) albo proforma (przelew)

Ciało (JSON)

PoleTypOpis
firmastring
emailstring
planstring
uzytkownicyinteger
nipstring
krajstring
platnoscstring
wyslijboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/skala/zakup" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"firma": ..., "email": ..., "plan": ...}'

Sla

get/api/slaSLA odpowiedzi: pasek czeka na nas, kolejka wg pilnosci, przekroczenia limitow z przyczyna, czas kolejka do wyslania, mediany per kanal

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/sla" \
  -H "Authorization: Bearer $KLUCZ"

Sledzenie

get/api/sledzenie/statystykiOtwarcia i klikniecia sledzonych maili (mail albo lead_id)

Parametry

NazwaGdzieTypWymagany
mailzapytaniestringnie
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/sledzenie/statystyki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/sledzenie/ustawieniaStan sledzenia maili i adresy z wylaczonym sledzeniem (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/sledzenie/ustawienia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/sledzenie/wylaczoneReczne wylaczenie albo przywrocenie sledzenia dla adresu (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
emailstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sledzenie/wylaczone" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"email": ...}'

Sso

get/api/sso/dostawcybez kluczaDostawcy logowania SSO dostepni w tej instancji

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X GET "$CRM/api/sso/dostawcy"
get/api/sso/google/startbez kluczaStart logowania przez Google (302 na ekran dostawcy)

Odpowiedzi

  • 302 Found
  • 409 Konflikt

Przykład

curl -sS -X GET "$CRM/api/sso/google/start"
get/api/sso/microsoft/startbez kluczaStart logowania przez Microsoft (302 na ekran dostawcy)

Odpowiedzi

  • 302 Found
  • 409 Konflikt

Przykład

curl -sS -X GET "$CRM/api/sso/microsoft/start"
get/api/sso/powiazaniaPowiazania kont CRM z adresami SSO (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/sso/powiazania" \
  -H "Authorization: Bearer $KLUCZ"
post/api/sso/powiazaniaPowiazanie konta z adresem Google/Microsoft albo usuniecie powiazania (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
loginstring
emailstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/sso/powiazania" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "email": ...}'

Stan instancji

get/api/zdrowieStan instancji: importy, spojnosc, dostep

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/zdrowie" \
  -H "Authorization: Bearer $KLUCZ"

Status

get/api/statusPubliczny stan instancji (skladniki ok, ostrzezenie, awaria); strona HTML pod /status

Odpowiedzi

  • 200 OK
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/status" \
  -H "Authorization: Bearer $KLUCZ"
get/api/status/historiabez kluczaPubliczna historia: przerwy serwisowe i incydenty z ostatnich 90 dni

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X GET "$CRM/api/status/historia"

Szablony jezykowe

get/api/szablony_jezykoweSzablony odpowiedzi EN i UA w tonie biznesowym z ocena jakosci 1-5 i srednia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/szablony_jezykowe" \
  -H "Authorization: Bearer $KLUCZ"
post/api/szablony_jezykoweZaklada brakujace szablony EN i UA w szablonach odpowiedzi karty (istniejace zostaja bez zmian)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/szablony_jezykowe" \
  -H "Authorization: Bearer $KLUCZ"

Szablony mcp

get/api/szablony_mcpKatalog pakietow szablonow zadan dla agentow MCP

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/szablony_mcp" \
  -H "Authorization: Bearer $KLUCZ"
get/api/szablony_mcp/podgladPodglad zmian pakietu szablonow zadan przed instalacja (dodaj, pomin, odcisk)

Parametry

NazwaGdzieTypWymagany
pakietzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/szablony_mcp/podglad" \
  -H "Authorization: Bearer $KLUCZ"
post/api/szablony_mcp/zainstalujInstalacja pakietu szablonow zadan; wymaga odcisku z podgladu

Ciało (JSON)

PoleTypOpis
pakietstring
odciskstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 409 Konflikt

Przykład

curl -sS -X POST "$CRM/api/szablony_mcp/zainstaluj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"pakiet": ..., "odcisk": ...}'

Szanse (leady)

get/api/leadyLista szans z filtrami

Zakres klucza: moduł szanse, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
statuszapytaniestringnie
etapzapytaniestringnie
oczekiwaniezapytaniestringnie
szukajzapytaniestringnie
zrodlozapytaniestringnie
opiekunzapytaniestringnie
tagzapytaniestringnie
odzapytaniestringnie
dozapytaniestringnie
limitzapytaniestringnie
pozapytaniestringnie
zmienione_odzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/leady" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "ile": 1,
  "ile_w_archiwum": 0,
  "ile_odlozonych": 0,
  "leady": [
    {
      "id": 17,
      "zrodlo": "reczne",
      "kanal": "reczny",
      "nazwa_kontaktu": "Jan Kowalski",
      "firma": "ACME Sp. z o.o.",
      "email": "jan@acme.pl",
      "tytul": "Kredyt dla firmy",
      "status": "w_trakcie",
      "etap": "nowe",
      "etap_reczny": false,
      "kwota": null,
      "opiekun": null,
      "organizacja_id": null,
      "pierwszy_kontakt": "2026-10-28T09:15:00"
    }
  ]
}
post/api/leadyNowa reczna szansa

Zakres klucza: moduł szanse, tryb zapis.

Ciało (JSON)

PoleTypOpis
firmastring
nazwa_kontaktustring
emailstring
tytulstringO co chodzi w szansie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/leady" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"firma": "ACME Sp. z o.o.", "nazwa_kontaktu": "Jan Kowalski", "email": "jan@acme.pl", "tytul": "Kredyt dla firmy"}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead": {
    "id": 17,
    "zrodlo": "reczne",
    "kanal": "reczny",
    "nazwa_kontaktu": "Jan Kowalski",
    "firma": "ACME Sp. z o.o.",
    "email": "jan@acme.pl",
    "tytul": "Kredyt dla firmy",
    "status": "w_trakcie",
    "etap": "nowe",
    "etap_reczny": false,
    "kwota": null,
    "opiekun": null,
    "organizacja_id": null,
    "pierwszy_kontakt": "2026-10-28T09:15:00"
  }
}
get/api/leady/{id}Karta szansy z notatkami, zadaniami i historia

Zakres klucza: moduł szanse, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/leady/123" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "lead": {
    "id": 17,
    "zrodlo": "reczne",
    "kanal": "reczny",
    "nazwa_kontaktu": "Jan Kowalski",
    "firma": "ACME Sp. z o.o.",
    "email": "jan@acme.pl",
    "tytul": "Kredyt dla firmy",
    "status": "w_trakcie",
    "etap": "nowe",
    "etap_reczny": false,
    "kwota": null,
    "opiekun": null,
    "organizacja_id": null,
    "pierwszy_kontakt": "2026-10-28T09:15:00"
  }
}
patch/api/leady/{id}Zmiana opiekuna, telefonu, nazwy kontaktu, odlozenia i pol wlasnych

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
opiekunstring | nullKlucz opiekuna albo login doradcy; null zdejmuje
telefonstring | null
nazwa_kontaktustring | null
odlozona_dostring | nullData odlozenia (RRRR-MM-DD); null przywraca
polaobjectPola wlasne {klucz: wartosc|null}; null kasuje wartosc, zly typ daje 422

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PATCH "$CRM/api/leady/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"telefon": "+48600100200", "pola": {"kanal_zgloszenia": "telefon"}}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead": {
    "id": 17,
    "zrodlo": "reczne",
    "kanal": "reczny",
    "nazwa_kontaktu": "Jan Kowalski",
    "firma": "ACME Sp. z o.o.",
    "email": "jan@acme.pl",
    "tytul": "Kredyt dla firmy",
    "status": "w_trakcie",
    "etap": "nowe",
    "etap_reczny": false,
    "kwota": null,
    "opiekun": null,
    "organizacja_id": null,
    "pierwszy_kontakt": "2026-10-28T09:15:00"
  }
}
post/api/leady/{id}/agencja/harmonogramHarmonogram realizacji z kamieni szablonu na dni robocze

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
startstring
godzinynumber
dni_roboczeinteger
szablon_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/agencja/harmonogram" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"start": ..., "godziny": ..., "dni_robocze": ...}'
post/api/leady/{id}/agencja/ofertaOferta kompletna: wycena, harmonogram i referencje w wersji oferty PDF

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
pozycjearray
godzinyarray
startstring
portfolioboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/agencja/oferta" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"pozycje": ..., "godziny": ..., "start": ...}'
get/api/leady/{id}/agencja/portfolioPortfolio i referencje pasujace do zlecenia (do oferty)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/agencja/portfolio" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/agencja/raport_klientaRaporty miesieczne dla klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/agencja/raport_klienta" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/agencja/raport_klientaGenerowanie raportu miesiecznego dla klienta (ruch, zmiany)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
miesiacstring
ruchobject
zmianystring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/agencja/raport_klienta" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"miesiac": ..., "ruch": ..., "zmiany": ...}'
get/api/leady/{id}/agencja/scoringPunkty i powody lead scoringu z audytu strony

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/agencja/scoring" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/agencja/umowyWersje szkicow umow szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/agencja/umowy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/agencja/umowySzkic umowy o dzielo albo zlecenia z przeniesieniem praw (wzor do weryfikacji prawnej)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
rodzajstring
prawaboolean
przedmiotstring
wynagrodzenienumber

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/agencja/umowy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "prawa": ..., "przedmiot": ...}'
get/api/leady/{id}/agencja/umowy/{uid}Tresc umowy (tekst i html)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/agencja/umowy/<uid>" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/agencja/wycenaWycena z katalogu i godzin: netto, brutto, koszt, marza i ostrzezenie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
pozycjearray
godzinyarray
rabat_procnumber
vatnumber

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/agencja/wycena" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"pozycje": ..., "godziny": ..., "rabat_proc": ...}'
get/api/leady/{id}/agencja/zasobyRepozytorium, hosting i domeny klienta z terminami

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/agencja/zasoby" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/agencja/zasobyNowy zasob klienta (repozytorium, hosting, domena, certyfikat)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
rodzajstring
nazwastring
adresstring
wygasastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/agencja/zasoby" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "nazwa": ..., "adres": ...}'
put/api/leady/{id}/agencja/zasoby/{zid}Zmiana zasobu klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
adresstring
wygasastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/leady/123/agencja/zasoby/<zid>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "adres": ..., "wygasa": ...}'
delete/api/leady/{id}/agencja/zasoby/{zid}Usuniecie zasobu klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/agencja/zasoby/<zid>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/agencja/zgoda_marzyZgody wlasciciela na marze ponizej progu dla szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/agencja/zgoda_marzy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/agencja/zgoda_marzyZgoda wlasciciela na oferte agenta z marza ponizej progu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
marza_procnumber
powodstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/agencja/zgoda_marzy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"marza_proc": ..., "powod": ...}'
get/api/leady/{id}/analiza_tresciTon, pilnosc i proponowane tagi z rozmowy z klientem (regulowo, nic nie zapisuje)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/analiza_tresci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/analiza_tresciDodaje tagi z analizy rozmowy do tagow szansy (bez usuwania istniejacych)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tagiarray

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/analiza_tresci" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tagi": ...}'
post/api/leady/{id}/ankietaAnkieta NPS albo satysfakcji z linkiem (opcjonalnie szkic maila)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
rodzajstring
szkic_mailaboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/ankieta" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "szkic_maila": ...}'
post/api/leady/{id}/archiwumZadanie klienta o skroceniu archiwizacji korespondencji

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
uwagistring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/leady/123/archiwum" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"uwagi": ...}'
post/api/leady/{id}/czasTimer czasu na szansie: start, stop albo reczny wpis

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring
minutyinteger
opisstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/czas" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "minuty": ..., "opis": ...}'
get/api/leady/{id}/czatCzat zespolu w szansie (po = tylko nowsze)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
pozapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/czat" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/czatWiadomosc na czacie szansy z @wzmiankami

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/czat" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
get/api/leady/{id}/dokumentyLista dokumentow szansy, zestawy, zalaczniki z poczty i prosby

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/dokumenty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/dokumentyDopisanie zestawu (zestaw) albo jednej pozycji (nazwa)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
zestawstring
nazwastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/dokumenty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zestaw": ..., "nazwa": ...}'
post/api/leady/{id}/dokumenty/poprosSzkic prosby o brakujace dokumenty do kolejki akceptacji (nic nie wysyla)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kanalyarray
ponowboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/dokumenty/popros" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kanaly": ..., "ponow": ...}'
patch/api/leady/{id}/dokumenty/{did}Stan dokumentu (brak, poproszono, otrzymano, odrzucono) i zalacznik z poczty

Parametry

NazwaGdzieTypWymagany
idadresintegertak
didadresintegertak

Ciało (JSON)

PoleTypOpis
stanstring
zalacznik_idstring
nazwastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PATCH "$CRM/api/leady/123/dokumenty/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"stan": ..., "zalacznik_id": ..., "nazwa": ...}'
delete/api/leady/{id}/dokumenty/{did}Usuniecie pozycji z listy dokumentow

Parametry

NazwaGdzieTypWymagany
idadresintegertak
didadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/dokumenty/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/dopasowanieRanking produktow bankowych dla klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/dopasowanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/dopasowanieRanking produktow z komentarzem AI (ai: true)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
aiboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/leady/123/dopasowanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ai": ...}'
get/api/leady/{id}/dziennik_kanalowDziennik kanalow leada z filtrem po kanale (kanal)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
kanalzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/dziennik_kanalow" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/eksport_rodoWszystkie dane szansy do odpowiedzi na wniosek RODO: format json, html albo pdf (tylko klucz pelny albo wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented

Przykład

curl -sS -X GET "$CRM/api/leady/123/eksport_rodo" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/etapReczna zmiana etapu lejka (etap auto wraca do wyliczanego)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
etapstringKlucz etapu z GET /api/etapy albo auto (powrot do etapu wyliczanego)
kwotanumberWymagana przy etapach, ktore tego wymagaja (inaczej 422 z lista pol)
terminstringTermin RRRR-MM-DD, gdy etap go wymaga

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/leady/123/etap" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"etap": "w_rozmowie"}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead": {
    "id": 17,
    "zrodlo": "reczne",
    "kanal": "reczny",
    "nazwa_kontaktu": "Jan Kowalski",
    "firma": "ACME Sp. z o.o.",
    "email": "jan@acme.pl",
    "tytul": "Kredyt dla firmy",
    "status": "w_trakcie",
    "etap": "w_rozmowie",
    "etap_reczny": true,
    "kwota": null,
    "opiekun": null,
    "organizacja_id": null,
    "pierwszy_kontakt": "2026-10-28T09:15:00"
  }
}
get/api/leady/{id}/faktury/{did}/xmlXML faktury w ksztalcie FA(3)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
didadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/faktury/123/xml" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/faktury/{fid}/pdfPDF faktury do pobrania (base64)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/faktury/<fid>/pdf" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/firma_wwwTelefon i NIP firmy szansy ze strony www firmy (tylko puste pola)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/leady/123/firma_www" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/fragmenty_ofert/zlozTekst warunkow albo uwag oferty ze fragmentow biblioteki

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
idsarray
polestring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/fragmenty_ofert/zloz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ids": ..., "pole": ...}'
get/api/leady/{id}/jakoscOcena, ostrzezenia, jezyk klienta, podpisy z maili i zalaczniki szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/jakosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/kalendarz_spotkanSpotkania szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/kalendarz_spotkan" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/kalendarz_spotkanSpotkanie z linkiem online, zadaniem i zaproszeniem ICS

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
startstring
minutyinteger
tytulstring
miejscestring
linkstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/kalendarz_spotkan" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"start": ..., "minuty": ..., "tytul": ...}'
post/api/leady/{id}/kanal_odpowiedziWybor kanalu odpowiedzi z karty zapisany w preferencje_klienta (nic nie wysyla)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kanalstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/kanal_odpowiedzi" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kanal": ...}'
post/api/leady/{id}/kanaly/odpowiedzOdpowiedz klientowi jego kanalem (Messenger, Instagram, WhatsApp) albo w czacie na stronie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/kanaly/odpowiedz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
post/api/leady/{id}/komentarzeKomentarz zespolu w szansie (watek, @wzmianki, powiadomienia)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring
rodzic_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/komentarze" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ..., "rodzic_id": ...}'
get/api/leady/{id}/komunikatoryWhatsApp i Messenger szansy: linki, adres i wiadomosci

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/komunikatory" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/komunikatoryZapis wiadomosci WhatsApp/Messenger (wyslanej albo wklejonej od klienta); odpowiedz niesie link

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kanalstring
trescstring
kierunekstring
adresstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/komunikatory" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kanal": ..., "tresc": ..., "kierunek": ...}'
get/api/leady/{id}/kontomatikZgody Kontomatik i ostatnia analiza rachunku sprawy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/kontomatik" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/kontomatikLink zgody na jednorazowy odczyt rachunku (link), anulowanie (anuluj) albo przeliczenie zdolnosci (przelicz)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/kontomatik" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'
post/api/leady/{id}/lejekPrzeniesienie szansy do innego lejka; etap spoza nowego lejka zamienia sie na jego pierwszy etap

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
lejekstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/lejek" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lejek": ...}'
get/api/leady/{id}/lojalnoscProgram lojalnosciowy szansy: saldo, poziom, ruchy, nagrody

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/lojalnosc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/lojalnoscReczne punkty albo wymiana nagrody (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
punktyinteger
powodstring
wymienstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/lojalnosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"punkty": ..., "powod": ..., "wymien": ...}'
get/api/leady/{id}/marketingMarketing szansy: atrybucja z kosztem leada, preferencje, ankiety, polecenia

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/marketing" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/metaOkna 24 h kanalow Meta z propozycja SMS albo maila, numer z rozmowy, stany wiadomosci i zalaczniki

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/meta" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/meta/przeniesPrzeniesienie szkicu z kanalu Meta (okno zamkniete) na SMS albo mail przez kolejke akceptacji

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/meta/przenies" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/nagraniaNagrania rozmow z centralki przypiete do szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/nagrania" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/naleznosciRaty platnosci, faktury i stan KSeF szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/naleznosci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/naleznosciAkcje naleznosci: harmonogram, zaplacona, anuluj, link, proforma, faktura, ksef_wyslij, ksef_status, ksef_numer

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/naleznosci" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'
get/api/leady/{id}/nawigacjaAdres klienta i odnosniki do nawigacji (geo, Google, Apple)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/nawigacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/nipFirma szansy z wykazu MF (NIP z wiadomosci albo podany)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nipstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/leady/123/nip" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nip": ...}'
get/api/leady/{id}/notatkiNotatki szansy

Zakres klucza: moduł szanse, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/leady/123/notatki" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "notatki": [
    {
      "id": 5,
      "lead_id": 17,
      "kiedy": "2026-10-28T09:20:00",
      "autor": "zapier",
      "tresc": "Klient prosi o telefon po 15:00."
    }
  ],
  "zadania": []
}
post/api/leady/{id}/notatkiNowa notatka (autor: nazwa klucza)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/leady/123/notatki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": "Klient prosi o telefon po 15:00."}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "notatki": [
    {
      "id": 5,
      "lead_id": 17,
      "kiedy": "2026-10-28T09:20:00",
      "autor": "zapier",
      "tresc": "Klient prosi o telefon po 15:00."
    }
  ],
  "zadania": [],
  "id": 5
}
post/api/leady/{id}/obecnoscSygnal ogladania karty; odpowiedz niesie ogladajacych i ostrzezenie o edycji

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
edytujeboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/obecnosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"edytuje": ...}'
get/api/leady/{id}/obowiazkiObowiazki informacyjne i elementy sprawy kredytowej

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/obowiazki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/obowiazkiZapis obowiazku informacyjnego (kiedy, kanal, kto)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
elementstring
kanalstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/obowiazki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"element": ..., "kanal": ...}'
post/api/leady/{id}/obserwujObserwowanie szansy: powiadomienia o zmianach

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
wlaczboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/obserwuj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlacz": ...}'
post/api/leady/{id}/odpowiedzSzkic odpowiedzi do kolejki akceptacji (nic nie wysyla)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 202 Przyjęto do kolejki
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/odpowiedz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
post/api/leady/{id}/odpowiedz/podgladPodglad szkicu odpowiedzi po zmianie kanalu (skrocony SMS, limity portali)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring
kanalstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/odpowiedz/podglad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ..., "kanal": ...}'
post/api/leady/{id}/oferta_aiPropozycja pozycji oferty z katalogu i rozmowy (nic nie zapisuje)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
wskazowkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/oferta_ai" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wskazowka": ...}'
get/api/leady/{id}/oferta_pdfOferta PDF szansy: wersje z sumami i marza (tylko tu), aktywny katalog i wartosci domyslne formularza

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/oferta_pdf" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/oferta_pdfNowa wersja oferty PDF (pozycje z katalogu albo reczne, ilosc, cena, rabat, VAT, waznosc, warunki) i zadanie przypomnienia dzien przed wygasnieciem; nic nie wysyla

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
pozycjearray
vatnumber
waznosc_dniinteger
waznosc_dostring
warunkistring
uwagistring
tytulstring
walutastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/oferta_pdf" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"pozycje": ..., "vat": ..., "waznosc_dni": ...}'
get/api/leady/{id}/oferta_pdf/{wersja}/akceptacjaPodpis akceptacji oferty w portalu i zgodnosc skrotu tresci

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/oferta_pdf/<wersja>/akceptacja" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/oferta_pdf/{wersja}/benchmarkPorownanie oferty z ofertami wygranych szans

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/oferta_pdf/<wersja>/benchmark" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/oferta_pdf/{wersja}/link_akceptacjiSzkic wiadomosci z publicznym linkiem do akceptacji oferty online (tylko w kolejce akceptacji)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kanalyarray

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/oferta_pdf/<wersja>/link_akceptacji" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kanaly": ...}'
get/api/leady/{id}/oferta_pdf/{wersja}/pdfPDF wersji oferty (HTML -> Chrome headless), bez kosztow i marzy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/leady/123/oferta_pdf/<wersja>/pdf" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/oferta_pdf/{wersja}/umowaSzkic umowy z danych oferty

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
rodzajstring
prawaboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/oferta_pdf/<wersja>/umowa" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "prawa": ...}'
post/api/leady/{id}/oferta_pdf/{wersja}/walutaNowa wersja oferty w walucie klienta po kursie NBP

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
walutastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/oferta_pdf/<wersja>/waluta" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"waluta": ...}'
get/api/leady/{id}/okazjeOkazje klienta (urodziny, rocznice)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/okazje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/okazjeNowa okazja klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
rodzajstring
datastring
etykietastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/okazje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "data": ..., "etykieta": ...}'
delete/api/leady/{id}/okazje/{okazja_id}Usuniecie okazji klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/okazje/{okazja_id}" \
  -H "Authorization: Bearer $KLUCZ"
put/api/leady/{id}/organizacjaUstawienie firmy szansy (istniejacej, nowej albo null)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
organizacja_idinteger | nullnull odpina firme
nowa

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PUT "$CRM/api/leady/123/organizacja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"organizacja_id": 2}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "osoby": [
    {
      "id": 4,
      "imie": "Jan",
      "nazwisko": "Kowalski",
      "imie_nazwisko": "Jan Kowalski",
      "email": "jan@acme.pl",
      "organizacja_id": 2
    }
  ],
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
get/api/leady/{id}/os-kanalowJedna os czasu wszystkich kanalow kontaktu z klientem

Parametry

NazwaGdzieTypWymagany
idadresintegertak
kanalzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/os-kanalow" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/osobyDopiecie osoby do szansy (istniejacej albo nowej)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
osoba_idintegerIstniejaca osoba
nowa
rolastringszef, kontaktowa, techniczna, ksiegowosc albo inna
glownaboolean
decydentboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/leady/123/osoby" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"osoba_id": 4, "rola": "kontaktowa", "glowna": true}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "osoby": [
    {
      "id": 4,
      "imie": "Jan",
      "nazwisko": "Kowalski",
      "imie_nazwisko": "Jan Kowalski",
      "email": "jan@acme.pl",
      "organizacja_id": 2
    }
  ],
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
put/api/leady/{id}/osoby/{osoba_id}Rola osoby przy szansie

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak
osoba_idadresintegertak

Ciało (JSON)

PoleTypOpis
osoba_idintegerIstniejaca osoba
nowa
rolastringszef, kontaktowa, techniczna, ksiegowosc albo inna
glownaboolean
decydentboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PUT "$CRM/api/leady/123/osoby/{osoba_id}" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rola": "szef", "decydent": true}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "osoby": [
    {
      "id": 4,
      "imie": "Jan",
      "nazwisko": "Kowalski",
      "imie_nazwisko": "Jan Kowalski",
      "email": "jan@acme.pl",
      "organizacja_id": 2
    }
  ],
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
delete/api/leady/{id}/osoby/{osoba_id}Odpiecie osoby od szansy

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak
osoba_idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/osoby/{osoba_id}" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "osoby": [],
  "organizacja": {
    "id": 2,
    "nazwa": "ACME Sp. z o.o.",
    "nip": "5260250274",
    "kraj": "PL",
    "miasto": "Warszawa"
  }
}
post/api/leady/{id}/otwartaZapis otwarcia karty w ostatnio otwieranych

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/otwarta" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/pakiet-kartyOdczyty sekcji karty szansy w jednym zapytaniu (sciezka: odpowiedz)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/leady/123/pakiet-karty" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/plikiPliki dolaczone do szansy (przeciagniecie na karte, zrzut ekranu)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/pliki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/plikiDodaje plik do szansy: nazwa z rozszerzeniem i dane w base64 (do 5 MB, 30 plikow na szanse)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
danestring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 413 Content Too Large
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/pliki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "dane": ...}'
get/api/leady/{id}/pliki/{plik}Bajty pliku szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/pliki/<plik>" \
  -H "Authorization: Bearer $KLUCZ"
delete/api/leady/{id}/pliki/{plik}Usuwa plik szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/pliki/<plik>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/poczta/{pid}/oryginalOryginalna wiadomosc z serwera poczty: naglowki, HTML oczyszczony i tekst

Parametry

NazwaGdzieTypWymagany
idadresintegertak
pidadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/poczta/<pid>/oryginal" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/podobnePodobne wygrane sprawy (TF-IDF) z orientacyjnym przedzialem kwot

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/podobne" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/podpisyDopisanie danych z podpisu nadawcy jego osobie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
adresstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/podpisy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"adres": ...}'
get/api/leady/{id}/podpowiedz_bankuTrzy propozycje banku z uzasadnieniem

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/podpowiedz_banku" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/polaczClick-to-call z panelu: proba polaczenia i adres tel:

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/polacz" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/polecenie-kodKod i link polecajacy klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/leady/123/polecenie-kod" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/porownaniePorownanie 3-5 ofert bankow: rata, RRSO, koszt calkowity

Parametry

NazwaGdzieTypWymagany
idadresintegertak
okreszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/porownanie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/portalPortal klienta szansy: logowania, linki, wiadomosci, pliki, udostepnione oferty i proformy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/portal" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/portal/linkSZKIC linku do portalu klienta w kolejce akceptacji (nic nie wysyla)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kanalyarray

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/portal/link" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kanaly": ...}'
get/api/leady/{id}/portal/pliki/{pid}Plik wgrany przez klienta w portalu (bajty)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
pidadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/portal/pliki/<pid>" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/portal/udostepnijOferta (wersja) albo proforma (id) widoczna w portalu klienta; cofnij ukrywa

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
ofertainteger
proformainteger
cofnijboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/portal/udostepnij" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"oferta": ..., "proforma": ..., "cofnij": ...}'
post/api/leady/{id}/portal/wiadomoscOdpowiedz doradcy w czacie portalu klienta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/portal/wiadomosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
get/api/leady/{id}/powtorkaOstrzezenie przed wyslaniem: ta sama tresc wyszla albo czeka jako szkic w ostatnich 24 h (parametr tresc)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
tresczapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/powtorka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/powtorkaTo samo ostrzezenie z trescia w ciele (nic nie zapisuje)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/powtorka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
post/api/leady/{id}/preferencjePreferowany kanal, godziny, jezyk i wykluczenie z kontaktu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kanalstring
godziny_odstring
godziny_dostring
jezykstring
nie_kontaktowacboolean
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/preferencje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kanal": ..., "godziny_od": ..., "godziny_do": ...}'
get/api/leady/{id}/projektProjekt wygranej szansy: kamienie, raty, godziny, rentownosc, serwis i SLA (albo propozycja zalozenia)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/projekt" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/projektZalozenie projektu wygranej szansy z szablonu (budzet i termin z umowy albo oferty)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
zakresstring
startstring
terminstring
budzetnumber
szablon_idstring
gwarancja_miesinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/projekt" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "zakres": ..., "start": ...}'
patch/api/leady/{id}/projektZmiana projektu: status, archiwum, termin, budzet, ankieta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
statusstring
archiwumboolean
terminstring
budzetnumber
ankieta_ocenainteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PATCH "$CRM/api/leady/123/projekt" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"status": ..., "archiwum": ..., "termin": ...}'
post/api/leady/{id}/projekt/abonamenty/{rid}/odnowOdnowienie abonamentu o jego okres z rata do wystawienia

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
platnoscboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt

Przykład

curl -sS -X POST "$CRM/api/leady/123/projekt/abonamenty/<rid>/odnow" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"platnosc": ...}'
post/api/leady/{id}/projekt/kamienie/{rid}/linkLink akceptacji etapu przez klienta (/akceptacja-etapu/<token>)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt

Przykład

curl -sS -X POST "$CRM/api/leady/123/projekt/kamienie/<rid>/link" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/projekt/platnosci/{rid}/proformaProforma do raty harmonogramu (numer wraca do raty)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/projekt/platnosci/<rid>/proforma" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/projekt/podsumowaniePodsumowanie projektu (model albo dane)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/leady/123/projekt/podsumowanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/projekt/protokolProtokol odbioru PDF: dzien odbioru, gwarancja, status gwarancja

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
odbior_dniastring
uwagistring
odbierajacystring
wymusboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/leady/123/projekt/protokol" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"odbior_dnia": ..., "uwagi": ..., "odbierajacy": ...}'
post/api/leady/{id}/projekt/{sekcja}Wpis projektu: kamienie, platnosci, godziny, koszty, abonamenty, zgloszenia, dokumenty

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
terminstring
kwota_nettonumber
minutyinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/projekt/<sekcja>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "termin": ..., "kwota_netto": ...}'
patch/api/leady/{id}/projekt/{sekcja}/{rid}Zmiana wpisu projektu (postep kamienia, status raty, status zgloszenia)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
postepinteger
statusstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PATCH "$CRM/api/leady/123/projekt/<sekcja>/<rid>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"postep": ..., "status": ...}'
delete/api/leady/{id}/projekt/{sekcja}/{rid}Usuniecie wpisu projektu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/projekt/<sekcja>/<rid>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/prompterStan prompteru rozmowy kredytowej: wlaczone i powod wylaczenia

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/prompter" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/prompterPlan rozmowy kredytowej modelem: 5 pytan, ryzyka i produkt z cytatami zrodel (tylko odczyt)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/prompter" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/prowizjaProwizja sprawy: kwota ze stawki, stan, historia, storno, dokumenty (wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/prowizja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/prywatnePrywatna notatka widoczna tylko dla autora

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/prywatne" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
post/api/leady/{id}/przekazPrzekazanie szansy innemu doradcy z notatka

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
opiekunstring
notatkastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/przekaz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"opiekun": ..., "notatka": ...}'
get/api/leady/{id}/rabatyProsby o zgode na rabat w szansie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/rabaty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/rabatyProsba o zgode wlasciciela na rabat powyzej progu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
rabat_procnumber
uzasadnieniestring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/rabaty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rabat_proc": ..., "uzasadnienie": ...}'
post/api/leady/{id}/rezerwacjeLink rezerwacji terminu dla klienta (strona /rezerwacja/<token>, PL/EN/UK, 14 dni, notatka, .ics, anulowanie)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
minutyinteger
wazny_dniinteger

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/rezerwacje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"minuty": ..., "wazny_dni": ...}'
get/api/leady/{id}/rozliczeniaRozliczenie prowizji z bankiem dla wybranego wniosku: oczekiwana, otrzymana, do rozliczenia, wplywy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/rozliczenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/rozliczeniaWplyw prowizji od banku wybranego wniosku (kwota, wplynelo, uwagi); kwota ujemna to korekta

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kwotanumber
wplynelostring
uwagistring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/rozliczenia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kwota": ..., "wplynelo": ..., "uwagi": ...}'
delete/api/leady/{id}/rozliczenia/{rid}Usuniecie wplywu prowizji

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/rozliczenia/<rid>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/rozmowyNagrania, poczta glosowa i proby polaczen szansy z transkrypcja, streszczeniem i nastrojem

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/rozmowy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/rozmowyZapis rozmowy: nagranie base64 albo transkrypcja (tylko ze zgoda), poczta glosowa

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
kierunekstring
rodzajstring
kiedystring
czas_sinteger
zgodaboolean
zgoda_podstawastring
audio_base64string
audio_typstring
transkrypcjastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/rozmowy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"kierunek": ..., "rodzaj": ..., "kiedy": ...}'
get/api/leady/{id}/skrzynka_smsWspólny wątek szansy: mail, Messenger, SMS, telefon, portal, z kosztem SMS

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/skrzynka_sms" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/smsSMS doradcy z karty: numer, gotowosc kanalu [sms], szablony z podstawionymi zmiennymi i SMS-y czekajace na decyzje

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/sms" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/smsSMS doradcy do kolejki akceptacji CRM (szablon albo tresc); nic nie wysyla, wysylka to Wyslij w /api/auto_odpowiedz/kolejka

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
szablonstring
trescstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/sms" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"szablon": ..., "tresc": ...}'
post/api/leady/{id}/sms/linkSMS z linkiem do portalu w kolejce akceptacji, link śledzony

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/sms/link" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/spamDecyzja spam albo nie spam (uczy filtr), opcjonalnie adres na stop-liste

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
spamboolean
stopboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/spam" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"spam": ..., "stop": ...}'
get/api/leady/{id}/spotkaniaSpotkania szansy (kalendarz, Calendly, Cal.com)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/spotkania" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/spotkaniaSpotkanie jako zdarzenie szansy

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
startstring
minutyinteger
tytulstring
miejscestring
uczestnicyarray
uidstring

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/spotkania" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"start": ..., "minuty": ..., "tytul": ...}'
post/api/leady/{id}/statusReczny status szansy

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
statusstringw_trakcie, wygrany, przegrany albo oferta_bez_odzewu
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/leady/123/status" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"status": "wygrany"}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead": {
    "id": 17,
    "zrodlo": "reczne",
    "kanal": "reczny",
    "nazwa_kontaktu": "Jan Kowalski",
    "firma": "ACME Sp. z o.o.",
    "email": "jan@acme.pl",
    "tytul": "Kredyt dla firmy",
    "status": "wygrany",
    "etap": "nowe",
    "etap_reczny": false,
    "kwota": null,
    "opiekun": null,
    "organizacja_id": null,
    "pierwszy_kontakt": "2026-10-28T09:15:00"
  }
}
post/api/leady/{id}/szybkoSzybka zmiana jednego pola karty szansy

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
wartoscstringWartosc jednego pola karty; e-mail dopina osobe

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/leady/123/szybko" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wartosc": "jan@acme.pl"}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead": {
    "id": 17,
    "zrodlo": "reczne",
    "kanal": "reczny",
    "nazwa_kontaktu": "Jan Kowalski",
    "firma": "ACME Sp. z o.o.",
    "email": "jan@acme.pl",
    "tytul": "Kredyt dla firmy",
    "status": "w_trakcie",
    "etap": "nowe",
    "etap_reczny": false,
    "kwota": null,
    "opiekun": null,
    "organizacja_id": null,
    "pierwszy_kontakt": "2026-10-28T09:15:00"
  }
}
post/api/leady/{id}/tlumaczTlumaczenie wiadomosci klienta modelem (pl, en, uk); nic nie zapisuje ani nie wysyla

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tekststring
nastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/tlumacz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "na": ...}'
post/api/leady/{id}/tlumacz_rozmoweTlumaczenie ostatnich wiadomosci klienta jednym wywolaniem modelu (nic nie zapisuje)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/leady/123/tlumacz_rozmowe" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"na": ...}'
post/api/leady/{id}/ulubionaGwiazdka: dodaje albo zdejmuje szanse z moich ulubionych

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
wlaczboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/ulubiona" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlacz": ...}'
get/api/leady/{id}/umowyUmowy szansy ze stanem podpisu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/umowy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/umowyNowa umowa z szablonu (kwota, termin, przedmiot z szansy)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
szablonstring
kwotanumber
terminstring
przedmiotstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/umowy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"szablon": ..., "kwota": ..., "termin": ...}'
post/api/leady/{id}/usun_daneUsuniecie danych klienta: anonimizacja szansy (tylko klucz pelny albo wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
potwierdzboolean
potwierdz_slowostring
powodstring
data_zadaniastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 500 Internal Server Error

Przykład

curl -sS -X POST "$CRM/api/leady/123/usun_dane" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"potwierdz": ..., "potwierdz_slowo": ..., "powod": ...}'
get/api/leady/{id}/watekWatek maili szansy ze wszystkich skrzynek, bez cytatow, ze znacznikami autorespondera i odbic

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/watek" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/watek/archiwizujArchiwizacja watku w skrzynce przez IMAP (tylko gdy [poczta_wysylka] archiwum_imap)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tematstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/leady/123/watek/archiwizuj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"temat": ...}'
get/api/leady/{id}/wnioskiWnioski bankowe szansy z podsumowaniem

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/wnioski" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/wnioskiNowy wniosek bankowy (bank, zlozono, kwota, status, warunki, uwagi, wazna_do tylko dla pozytywnej, powod_odmowy tylko dla negatywnej, prowizja_oczekiwana)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
bankstring
zlozonostring
kwotanumber
statusstring
decyzja_dniastring
warunkistring
uwagistring
wazna_dostring
powod_odmowystring
prowizja_oczekiwananumber

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/wnioski" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"bank": ..., "zlozono": ..., "kwota": ...}'
patch/api/leady/{id}/wnioski/{wid}Zmiana wniosku bankowego; wybrany=true to wybor klienta (tylko pozytywna decyzja); wazna_do (pozytywna), powod_odmowy (negatywna: bik, dochod, zatrudnienie, dti, inne), prowizja_oczekiwana

Parametry

NazwaGdzieTypWymagany
idadresintegertak
widadresintegertak

Ciało (JSON)

PoleTypOpis
bankstring
zlozonostring
kwotanumber
statusstring
decyzja_dniastring
warunkistring
uwagistring
wybranyboolean
wazna_dostring
powod_odmowystring
prowizja_oczekiwananumber

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PATCH "$CRM/api/leady/123/wnioski/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"bank": ..., "zlozono": ..., "kwota": ...}'
delete/api/leady/{id}/wnioski/{wid}Usuniecie wniosku bankowego

Parametry

NazwaGdzieTypWymagany
idadresintegertak
widadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/wnioski/123" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/wolne-oknaWolne okna rozmowy wg godzin pracy, zadan, spotkan i kalendarzy ICS

Parametry

NazwaGdzieTypWymagany
idadresintegertak
minutyzapytaniestringnie
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/wolne-okna" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/wspolpracaKarta: komentarze z watkami, obserwujacy, ogladajacy, czas i moje prywatne notatki

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/wspolpraca" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/wycofaj_daneWycofanie wszystkich zgod klienta, wylaczenie kontaktu i wniosek o zapomnienie; anonimizacja w ciagu 24 h w cyklu automatu (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/leady/123/wycofaj_dane" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"powod": ...}'
get/api/leady/{id}/wysylkiStan szkicow i wysylek odpowiedzi leada: w kolejce, zatwierdzone, wyslane, blad z przyczyna

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/wysylki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/wysylki/{klucz}/ponowPonowienie nieudanej wysylki odpowiedzi

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 409 Konflikt

Przykład

curl -sS -X POST "$CRM/api/leady/123/wysylki/<klucz>/ponow" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/zadaniaZadania jednej szansy

Zakres klucza: moduł szanse, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/leady/123/zadania" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "notatki": [],
  "zadania": [
    {
      "id": 9,
      "lead_id": 17,
      "utworzono": "2026-10-28T09:21:00",
      "termin": "2026-10-30",
      "tresc": "Oddzwonic w sprawie oferty",
      "autor": "zapier",
      "zrobione": null,
      "zalegle": false,
      "priorytet": 2
    }
  ]
}
post/api/leady/{id}/zadaniaNowe zadanie z terminem (autor: nazwa klucza)

Zakres klucza: moduł szanse, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring
terminstringRRRR-MM-DD albo RRRR-MM-DDTGG:MM

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/leady/123/zadania" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": "Oddzwonic w sprawie oferty", "termin": "2026-10-30"}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "notatki": [],
  "zadania": [
    {
      "id": 9,
      "lead_id": 17,
      "utworzono": "2026-10-28T09:21:00",
      "termin": "2026-10-30",
      "tresc": "Oddzwonic w sprawie oferty",
      "autor": "zapier",
      "zrobione": null,
      "zalegle": false,
      "priorytet": 2
    }
  ],
  "id": 9
}
post/api/leady/{id}/zadania-aiZadania z rozmowy modelem (podglad; zapisz=true tworzy)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tekststring
zapiszboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/zadania-ai" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "zapisz": ...}'
post/api/leady/{id}/zadania-z-szablonuZadania z aktywnych szablonow etapu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
wyzwalaczstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/zadania-z-szablonu" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wyzwalacz": ...}'
post/api/leady/{id}/zadanie-z-mailaZadanie z maila szansy jednym kliknieciem (termin rozpoznany z tresci)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
poczta_idinteger
terminstring
przypisanystring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/zadanie-z-maila" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"poczta_id": ..., "termin": ..., "przypisany": ...}'
post/api/leady/{id}/zadanie-z-tekstuZadanie z wolnego zdania, termin rozpoznany z tekstu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
tekststring
terminstring
przypisanystring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/zadanie-z-tekstu" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "termin": ..., "przypisany": ...}'
get/api/leady/{id}/zalacznikiPliki szansy: zespolu, z portalu klienta i zalaczniki maili

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/zalaczniki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/zalacznikiPlik, notatka glosowa albo wideo (base64, transkrypcja)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
typstring
dane_base64string
rodzajstring
transkrypcjastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 413 Content Too Large
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/zalaczniki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "typ": ..., "dane_base64": ...}'
get/api/leady/{id}/zalaczniki/{poczta}/{numer}Tresc zalacznika maila szansy (obraz inline, reszta do pobrania)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X GET "$CRM/api/leady/123/zalaczniki/<poczta>/<numer>" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/zdolnoscZdolnosc ze sprawy i werdykt dla kwoty wnioskowanej

Parametry

NazwaGdzieTypWymagany
idadresintegertak
okreszapytaniestringnie
oprocentowaniezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/leady/123/zdolnosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/leady/{id}/zgodyZgody RODO szansy i ostrzezenie o braku zgody na przetwarzanie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/leady/123/zgody" \
  -H "Authorization: Bearer $KLUCZ"
post/api/leady/{id}/zgodyZapis albo odnowienie zgody (rodzaj marketing, przetwarzanie, bik)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
rodzajstring
zrodlostring
kiedystring
tresc_skrotstring
dowodstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/leady/123/zgody" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "zrodlo": ..., "kiedy": ...}'
patch/api/leady/{id}/zgody/{rodzaj}Wycofanie zgody (wycofana: true) albo cofniecie wycofania

Parametry

NazwaGdzieTypWymagany
idadresintegertak
rodzajadresstringtak

Ciało (JSON)

PoleTypOpis
wycofanaboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PATCH "$CRM/api/leady/123/zgody/<rodzaj>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wycofana": ...}'
delete/api/leady/{id}/zgody/{rodzaj}Usuniecie zapisu zgody

Parametry

NazwaGdzieTypWymagany
idadresintegertak
rodzajadresstringtak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/leady/123/zgody/<rodzaj>" \
  -H "Authorization: Bearer $KLUCZ"

Szukaj

get/api/szukaj/kontaktSzanse po numerze telefonu (same cyfry) albo fragmencie adresu e-mail

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/szukaj/kontakt" \
  -H "Authorization: Bearer $KLUCZ"
get/api/szukaj/znaczenioweWyszukiwanie znaczeniowe szans: zapytanie rozszerzone o synonimy, ranking podobienstwa tekstu

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/szukaj/znaczeniowe" \
  -H "Authorization: Bearer $KLUCZ"

Tagi

get/api/tagiTagi z liczbami, kolorem i paleta kolorow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/tagi" \
  -H "Authorization: Bearer $KLUCZ"
put/api/tagi/kolorKolor tagu z palety (null zdejmuje)

Ciało (JSON)

PoleTypOpis
tagstring
kolorstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/tagi/kolor" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tag": ..., "kolor": ...}'

Tekst

get/api/tekstTekstowa wersja panelu bez JavaScriptu (HTML) na wypadek awarii

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/tekst" \
  -H "Authorization: Bearer $KLUCZ"

Terminarz

get/api/terminarz/dostepnoscDostepnosc opiekuna dla rezerwacji z linku (dni, godziny, minuty, bufor, wyprzedzenie)

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/terminarz/dostepnosc" \
  -H "Authorization: Bearer $KLUCZ"
put/api/terminarz/dostepnoscZapis dostepnosci opiekuna

Ciało (JSON)

PoleTypOpis
dniarray
odstring
dostring
minutyinteger
bufor_mininteger
wyprzedzenie_hinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/terminarz/dostepnosc" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"dni": ..., "od": ..., "do": ...}'
get/api/terminarz/dzienZadania, spotkania i zajete okna dnia

Parametry

NazwaGdzieTypWymagany
datazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/terminarz/dzien" \
  -H "Authorization: Bearer $KLUCZ"
post/api/terminarz/importImport kalendarza ICS (zajete okna)

Ciało (JSON)

PoleTypOpis
icsstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/terminarz/import" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ics": ...}'
post/api/terminarz/przypomnieniaSzkice przypomnien o spotkaniach (mail, SMS do kolejki)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/terminarz/przypomnienia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/terminarz/subskrypcjaAdres subskrypcji ICS kalendarza konta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/terminarz/subskrypcja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/terminarz/synchronizujPobranie kalendarzy z [terminarz] ics_zewnetrzne

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/terminarz/synchronizuj" \
  -H "Authorization: Bearer $KLUCZ"

Tlo

post/api/tloZlecenie zadania w tle (szkic_poczty, import_csv, wysylka_maila); odpowiedz 202 z numerem, wynik z GET /api/tlo/{id}

Ciało (JSON)

PoleTypOpis
rodzajstring
daneobject

Odpowiedzi

  • 202 Przyjęto do kolejki
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/tlo" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rodzaj": ..., "dane": ...}'
get/api/tlo/{id}Stan i wynik zadania w tle (autor albo wlasciciel)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/tlo/123" \
  -H "Authorization: Bearer $KLUCZ"

Tryb awaryjny

get/api/tryb_awaryjnyCzy panel jest w trybie awaryjnym (tylko odczyt)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/tryb_awaryjny" \
  -H "Authorization: Bearer $KLUCZ"
post/api/tryb_awaryjnyWlaczenie i wylaczenie trybu awaryjnego (wlasciciel)

Ciało (JSON)

PoleTypOpis
wlaczonyboolean
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/tryb_awaryjny" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlaczony": ..., "powod": ...}'

Ulubione

get/api/ulubioneMoje ulubione szanse (gwiazdka)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/ulubione" \
  -H "Authorization: Bearer $KLUCZ"

Umowy

get/api/umowy/szablonySzablony umow i pola do wypelnienia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/umowy/szablony" \
  -H "Authorization: Bearer $KLUCZ"
post/api/umowy/{id}Wyslanie umowy do podpisu (link /umowa/<token>) albo anulowanie

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/umowy/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'
get/api/umowy/{id}/dokumentHTML umowy z blokiem podpisu elektronicznego

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/umowy/123/dokument" \
  -H "Authorization: Bearer $KLUCZ"

Uprawnienia

get/api/uprawnieniaUprawnienia rekordow i pol (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/uprawnienia" \
  -H "Authorization: Bearer $KLUCZ"
put/api/uprawnieniaZapis uprawnien: widocznosc szans i poziomy pol per rola i konto

Ciało (JSON)

PoleTypOpis
roleobject
kontaobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/uprawnienia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"role": ..., "konta": ...}'

Ustawienia instancji

get/api/ustawieniaUstawienia instancji bez sekretow (tylko klucz pelny)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/ustawienia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zrodlaWlaczenie i wylaczenie zrodel

Ciało (JSON)

PoleTypOpis
zrodlaobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zrodla" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zrodla": ...}'

V1

post/api/v1/wejscie/{token}bez kluczaWebhook przychodzacy: tworzy szanse z zgloszenia obcego systemu

Parametry

NazwaGdzieTypWymagany
tokenadresstringtak

Ciało (JSON)

PoleTypOpis
idstringId w systemie nadawcy; to samo id drugi raz nie tworzy szansy
nazwastring
emailstring
telefonstring
firmastring
tytulstring
wiadomoscstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/v1/wejscie/<token>" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "nazwa": ..., "email": ...}'

Wartosci leadow

get/api/wartosci_leadowWartosc wazona leadow i zmiana od wczoraj (liczona przez CRM na zywo), wlasciciel; handlowiec tylko swoja wyplata

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/wartosci_leadow" \
  -H "Authorization: Bearer $KLUCZ"

Wdrozenie

get/api/wdrozenieWdrozenie u klienta: ankieta, checklisty, kontakty, pilot, uwagi, zadowolenie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/ankietaZapis odpowiedzi ankiety przedwdrozeniowej

Ciało (JSON)

PoleTypOpis
odpowiedziobject

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/ankieta" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"odpowiedzi": ...}'
post/api/wdrozenie/checklistaOdhaczenie pozycji checklisty (tydzien, rodo, offboarding) albo podpis RODO

Ciało (JSON)

PoleTypOpis
listastring
pozycjainteger
zrobioneboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/checklista" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"lista": ..., "pozycja": ..., "zrobione": ...}'
get/api/wdrozenie/dokumentacjaDokumentacja instancji w Markdown

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/dokumentacja" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/dostepRejestr miejsca przechowywania dostepu (sejf), bez wartosci sekretu

Ciało (JSON)

PoleTypOpis
systemstring
gdziestring
wlascicielstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/dostep" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"system": ..., "gdzie": ..., "wlasciciel": ...}'
get/api/wdrozenie/dostepyAudyt kluczy i hasel: tryb plikow, jawne sekrety w konfiguracji, rejestr dostepow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/dostepy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/historiaImport historii klienta (CSV, Pipedrive, HubSpot, Zoho) z raportem, domyslnie na sucho

Ciało (JSON)

PoleTypOpis
systemstring
plikiobject

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/historia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"system": ..., "pliki": ...}'
get/api/wdrozenie/konfiguratorinstancja.toml i polecenie zalozenia instancji z ankiety

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/konfigurator" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/kontaktOpiekun wdrozenia i kontakt awaryjny

Ciało (JSON)

PoleTypOpis
rolastring
nazwastring
kanalstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/kontakt" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"rola": ..., "nazwa": ..., "kanal": ...}'
get/api/wdrozenie/lejekEtapy lejka ustawione w panelu z liczba spraw

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/lejek" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/lejekZapis etapow lejka (kolejnosc, nazwy, role) bez restartu

Ciało (JSON)

PoleTypOpis
etapyarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/lejek" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"etapy": ...}'
get/api/wdrozenie/odbiorWyniki testow odbiorczych (SPF, formularz, centralka, aplikacje) i urzadzen

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/odbior" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/odbiorUruchomienie testu odbiorczego

Ciało (JSON)

PoleTypOpis
teststring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/odbior" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"test": ...}'
get/api/wdrozenie/pilotPrzeglad i raport pilotazu wzgledem miernikow

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/pilot" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/pilotStart pilotazu i mierniki sukcesu

Ciało (JSON)

PoleTypOpis
startstring
miernikiarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/pilot" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"start": ..., "mierniki": ...}'
get/api/wdrozenie/po-pilotazuProjekt umowy i pierwszej proformy po pilotazu

Parametry

NazwaGdzieTypWymagany
planzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/po-pilotazu" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wdrozenie/posrednikWdrozenia posrednikow kredytowych: dzien planu 14 dni, blokady, hypercare, testy, NPS

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/posrednik" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wdrozenie/posrednik/odbiorLista odbioru wdrozenia posrednika: 25 kontroli

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/posrednik/odbior" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/posrednik/{akcja}Akcja rejestru wdrozen posrednikow (utworz, dzien, blokada, zdejmij, przeglad, zgloszenie, odpowiedz, nagranie, test, ankieta, potwierdz, cofnij)

Ciało (JSON)

PoleTypOpis
klientstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/posrednik/<akcja>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"klient": ...}'
get/api/wdrozenie/przekazanieGotowosc do przekazania do utrzymania (protokol=1 dolacza protokol)

Parametry

NazwaGdzieTypWymagany
protokolzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/przekazanie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/przekazaniePodpisanie przekazania do utrzymania

Ciało (JSON)

PoleTypOpis
przyjmujestring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/przekazanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"przyjmuje": ...}'
get/api/wdrozenie/rozszerzeniePlan rozszerzenia: zuzycie planu, zrodla do podpiecia, kolejny plan

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/rozszerzenie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wdrozenie/szkolenieAgenda szkolenia 1 h z kontami instancji, napisy SRT i zapisane nagrania

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/szkolenie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/szkolenieZapis szkolenia z linkiem do nagrania (odhacza pozycje checklisty)

Ciało (JSON)

PoleTypOpis
datastring
nagranie_urlstring
prowadzacystring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/szkolenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"data": ..., "nagranie_url": ..., "prowadzacy": ...}'
post/api/wdrozenie/urzadzenieReczne potwierdzenie aplikacji na telefonie doradcy

Ciało (JSON)

PoleTypOpis
loginstring
urzadzeniestring
dzialaboolean

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/urzadzenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "urzadzenie": ..., "dziala": ...}'
get/api/wdrozenie/uwagiUwagi klienta od najpilniejszej

Parametry

NazwaGdzieTypWymagany
tydzienzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/wdrozenie/uwagi" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/uwagiNowa uwaga klienta

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/uwagi" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'
post/api/wdrozenie/uwagi/{id}Status i priorytet uwagi

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/uwagi/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wdrozenie/zadowolenieAnkieta zadowolenia po wdrozeniu (NPS)

Ciało (JSON)

PoleTypOpis
ocenainteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wdrozenie/zadowolenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ocena": ...}'

Webhooki

get/api/webhookiWebhooki (bez sekretow), katalog zdarzen i dziennik dostaw

Zakres klucza: moduł ustawienia, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/webhooki" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "webhooki": [
    {
      "id": 3,
      "nazwa": "n8n",
      "url": "https://example.com/hook",
      "zdarzenia": [
        "nowy_lead",
        "wygrana"
      ],
      "aktywny": true,
      "ma_sekret": true,
      "utworzono": "2026-10-28T09:00:00",
      "ostatnia": null,
      "filtr_zrodla": [],
      "filtr_etapy": [],
      "lekki": false,
      "wstrzymany": null,
      "wstrzymanie_powod": null,
      "bledy_z_rzedu": 0
    }
  ],
  "zdarzenia": [
    {
      "klucz": "nowy_lead",
      "nazwa": "Nowy lead"
    }
  ]
}
post/api/webhookiNowy webhook; sekret podpisu HMAC-SHA256 zwracany raz

Zakres klucza: moduł ustawienia, tryb zapis.

Ciało (JSON)

PoleTypOpis
nazwastring
urlstringhttps; http tylko dla hostow lokalnych
zdarzeniaarray
sekretstringBrak = wygenerowany i zwrocony raz
aktywnyboolean
nowy_sekretbooleanTylko PUT: odnawia sekret
filtr_zrodlaarrayTylko szanse z tych zrodel
filtr_etapyarrayTylko zdarzenia z tych etapow
lekkibooleanLadunek bez danych osobowych: tylko id i typ

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/webhooki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": "n8n", "url": "https://example.com/hook", "zdarzenia": ["nowy_lead"]}'

Przykładowa odpowiedź

{
  "ok": true,
  "id": 3,
  "sekret": "whsec_example",
  "webhooki": [
    {
      "id": 3,
      "nazwa": "n8n",
      "url": "https://example.com/hook",
      "zdarzenia": [
        "nowy_lead",
        "wygrana"
      ],
      "aktywny": true,
      "ma_sekret": true,
      "utworzono": "2026-10-28T09:00:00",
      "ostatnia": null,
      "filtr_zrodla": [],
      "filtr_etapy": [],
      "lekki": false,
      "wstrzymany": null,
      "wstrzymanie_powod": null,
      "bledy_z_rzedu": 0
    }
  ]
}
post/api/webhooki/dostawy/{id}/ponowWysyla dostawe ponownie, ten sam ladunek i ten sam id_dostawy

Zakres klucza: moduł ustawienia, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/webhooki/dostawy/123/ponow" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "webhooki": [
    {
      "id": 3,
      "nazwa": "n8n",
      "url": "https://example.com/hook",
      "zdarzenia": [
        "nowy_lead",
        "wygrana"
      ],
      "aktywny": true,
      "ma_sekret": true,
      "utworzono": "2026-10-28T09:00:00",
      "ostatnia": null,
      "filtr_zrodla": [],
      "filtr_etapy": [],
      "lekki": false,
      "wstrzymany": null,
      "wstrzymanie_powod": null,
      "bledy_z_rzedu": 0
    }
  ]
}
get/api/webhooki/wejsciaTokeny webhookow przychodzacych (bez wartosci tokenu)

Zakres klucza: moduł ustawienia, tryb odczyt.

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/webhooki/wejscia" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "wejscia": [
    {
      "id": 1,
      "nazwa": "Zapier",
      "prefiks": "whin_aB3d...",
      "zrodlo": "zapier",
      "aktywny": true,
      "utworzono": "2026-11-01T09:00:00",
      "ostatnio": null,
      "przyjete": 0,
      "odrzucone": 0
    }
  ]
}
post/api/webhooki/wejsciaNowy token wejscia; pelny token widac raz

Zakres klucza: moduł ustawienia, tryb zapis.

Ciało (JSON)

PoleTypOpis
nazwastringDo 80 znakow
zrodlostringMale litery, cyfry, podkreslenia; domyslnie webhook

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/webhooki/wejscia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": "Zapier", "zrodlo": "zapier"}'

Przykładowa odpowiedź

{
  "ok": true,
  "id": 1,
  "token": "whin_example",
  "wejscia": [
    {
      "id": 1,
      "nazwa": "Zapier",
      "prefiks": "whin_aB3d...",
      "zrodlo": "zapier",
      "aktywny": true,
      "utworzono": "2026-11-01T09:00:00",
      "ostatnio": null,
      "przyjete": 0,
      "odrzucone": 0
    }
  ]
}
delete/api/webhooki/wejscia/{id}Usuwa token wejscia; zgloszenia z nim przestaja byc przyjmowane

Zakres klucza: moduł ustawienia, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X DELETE "$CRM/api/webhooki/wejscia/123" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "wejscia": []
}
put/api/webhooki/{id}Zmiana webhooka, wlaczenie i wylaczenie, nowy_sekret odnawia sekret

Zakres klucza: moduł ustawienia, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
urlstringhttps; http tylko dla hostow lokalnych
zdarzeniaarray
sekretstringBrak = wygenerowany i zwrocony raz
aktywnyboolean
nowy_sekretbooleanTylko PUT: odnawia sekret
filtr_zrodlaarrayTylko szanse z tych zrodel
filtr_etapyarrayTylko zdarzenia z tych etapow
lekkibooleanLadunek bez danych osobowych: tylko id i typ

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PUT "$CRM/api/webhooki/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": "n8n", "url": "https://example.com/hook", "zdarzenia": ["wygrana"], "aktywny": false}'

Przykładowa odpowiedź

{
  "ok": true,
  "id": 3,
  "webhooki": [
    {
      "id": 3,
      "nazwa": "n8n",
      "url": "https://example.com/hook",
      "zdarzenia": [
        "nowy_lead",
        "wygrana"
      ],
      "aktywny": true,
      "ma_sekret": true,
      "utworzono": "2026-10-28T09:00:00",
      "ostatnia": null,
      "filtr_zrodla": [],
      "filtr_etapy": [],
      "lekki": false,
      "wstrzymany": null,
      "wstrzymanie_powod": null,
      "bledy_z_rzedu": 0
    }
  ]
}
delete/api/webhooki/{id}Usuniecie webhooka razem z dziennikiem dostaw

Zakres klucza: moduł ustawienia, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X DELETE "$CRM/api/webhooki/123" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "webhooki": []
}
get/api/webhooki/{id}/dostawyDziennik dostaw jednego webhooka: kod, czas, sekwencja, blad

Zakres klucza: moduł ustawienia, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/webhooki/123/dostawy" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "dostawy": [
    {
      "id": 12,
      "webhook_id": 3,
      "zdarzenie": "nowy_lead",
      "stan": "dostarczone",
      "kod": 200,
      "czas_ms": 84,
      "proby": 1,
      "sekwencja": 1,
      "blad": null
    }
  ]
}
post/api/webhooki/{id}/testWysyla od razu zdarzenie test i zwraca wpis dziennika z kodem odpowiedzi

Zakres klucza: moduł ustawienia, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/webhooki/123/test" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "webhooki": [
    {
      "id": 3,
      "nazwa": "n8n",
      "url": "https://example.com/hook",
      "zdarzenia": [
        "nowy_lead",
        "wygrana"
      ],
      "aktywny": true,
      "ma_sekret": true,
      "utworzono": "2026-10-28T09:00:00",
      "ostatnia": null,
      "filtr_zrodla": [],
      "filtr_etapy": [],
      "lekki": false,
      "wstrzymany": null,
      "wstrzymanie_powod": null,
      "bledy_z_rzedu": 0
    }
  ]
}
post/api/webhooki/{id}/wznowWznawia webhook wstrzymany po 50 kolejnych bledach

Zakres klucza: moduł ustawienia, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/webhooki/123/wznow" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "webhooki": [
    {
      "id": 3,
      "nazwa": "n8n",
      "url": "https://example.com/hook",
      "zdarzenia": [
        "nowy_lead",
        "wygrana"
      ],
      "aktywny": true,
      "ma_sekret": true,
      "utworzono": "2026-10-28T09:00:00",
      "ostatnia": null,
      "filtr_zrodla": [],
      "filtr_etapy": [],
      "lekki": false,
      "wstrzymany": null,
      "wstrzymanie_powod": null,
      "bledy_z_rzedu": 0
    }
  ]
}

Wejścia (formularz, telefon, SMS)

get/api/orange/pilotTest pilota: czy polaczenie z numeru testowego dotarlo do karty leada

Parametry

NazwaGdzieTypWymagany
numerzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/orange/pilot" \
  -H "Authorization: Bearer $KLUCZ"
get/api/orange/wdrozenieLista kontrolna wdrozenia telefonii Orange, harmonogram z operatorem i pokrycie kart

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/orange/wdrozenie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/orange/wdrozenieTermin i stan kroku wdrozenia Orange

Ciało (JSON)

PoleTypOpis
krokstring
stanstring
terminstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/orange/wdrozenie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"krok": ..., "stan": ..., "termin": ...}'
get/api/telefon/aktywnoscKiedy i ile rozmawiali doradcy: per konto i dzien oraz lista rozmow

Parametry

NazwaGdzieTypWymagany
odzapytaniestringnie
dozapytaniestringnie
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/aktywnosc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/awariaRaport awarii aplikacji Dzwonek: licznik sesji i zapisane wyjatki (bez tresci klientow)

Ciało (JSON)

PoleTypOpis
urzadzeniestring
wersjastring
wariantstring
sdkinteger
sesjeinteger
awariearray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/awaria" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"urzadzenie": ..., "wersja": ..., "wariant": ...}'
get/api/telefon/diagnostykaZlecenia diagnostyki i ich wyniki

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/diagnostyka" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/diagnostykaZlecenie zdalnej diagnostyki telefonu doradcy (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
loginstring
urzadzeniestring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/diagnostyka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "urzadzenie": ...}'
get/api/telefon/diagnostyka/zleceniaZlecenia diagnostyki oczekujace na ten telefon

Parametry

NazwaGdzieTypWymagany
urzadzeniezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/diagnostyka/zlecenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/diagnostyka/{numer}/wynikWynik diagnostyki odeslany przez telefon

Ciało (JSON)

PoleTypOpis
urzadzeniestring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/diagnostyka/<numer>/wynik" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"urzadzenie": ...}'
post/api/telefon/nagraniaWgranie nagrania rozmowy (surowe bajty audio) do polaczenia z wgranego rejestru

Parametry

NazwaGdzieTypWymagany
ext_idzapytaniestringnie
rozszerzeniezapytaniestringnie

Odpowiedzi

  • 201 Utworzono
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 411 Length Required
  • 413 Content Too Large
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/nagrania" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/niezawodnosc/aktualizacjaAktualizacja: APK z serwera (bezposredni) albo tylko Play (sklep)

Parametry

NazwaGdzieTypWymagany
kanalzapytaniestringnie
kod_wersjizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/aktualizacja" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/niezawodnosc/bateriaInstrukcja wylaczenia optymalizacji baterii (Samsung, Xiaomi, Pixel, inne)

Parametry

NazwaGdzieTypWymagany
producentzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/bateria" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/niezawodnosc/bledyZagregowane bledy aplikacji (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/bledy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/niezawodnosc/bledyBlad aplikacji bez tresci rozmow i danych osobowych

Ciało (JSON)

PoleTypOpis
komunikatstring
miejscestring
wersjastring
modelstring
androidstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/niezawodnosc/bledy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"komunikat": ..., "miejsce": ..., "wersja": ...}'
get/api/telefon/niezawodnosc/gotowoscCzy wszystko dziala: siec, powiadomienia, bateria, ostatni dzwonek

Parametry

NazwaGdzieTypWymagany
urzadzeniezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/gotowosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/niezawodnosc/macierzMacierz modeli i wersji Androida z wynikami prob dzwonka (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/macierz" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/niezawodnosc/testProba dzwonka z pomiarem czasu dotarcia pusha

Ciało (JSON)

PoleTypOpis
loginstring
urzadzeniestring

Odpowiedzi

  • 202 Przyjęto do kolejki
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/telefon/niezawodnosc/test" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "urzadzenie": ...}'
post/api/telefon/niezawodnosc/test/{numer}/dotarlPotwierdzenie odebrania pusha testowego z podpisem zdarzenia

Ciało (JSON)

PoleTypOpis
tsinteger
podpisstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/telefon/niezawodnosc/test/<numer>/dotarl" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ts": ..., "podpis": ...}'
get/api/telefon/niezawodnosc/testyStatystyki prob dzwonka: mediana, p95, odsetek ponizej 5 s (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
producentzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/testy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/niezawodnosc/uniewaznijZdalne wylogowanie telefonu (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
loginstring
urzadzeniestring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/niezawodnosc/uniewaznij" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"login": ..., "urzadzenie": ...}'
get/api/telefon/niezawodnosc/uprawnieniaUprawnienia aplikacji Dzwonek z uzasadnieniem

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/uprawnienia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/niezawodnosc/ustawieniaTryb polaczenia telefonu (push, long-poll) zalezny od zuzycia baterii

Parametry

NazwaGdzieTypWymagany
urzadzeniezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/ustawienia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/niezawodnosc/wersjeTelefony zespolu z wersja aplikacji i data (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/niezawodnosc/wersje" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/oddzwonKolejka oddzwonien z propozycja doradcy na dyzurze

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/telefon/oddzwon" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/polaczeniaRozmowy telefoniczne szansy z czasem i znacznikiem nagrania

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/polaczenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/polaczeniaWgranie rejestru polaczen z telefonu doradcy (idempotentnie po id z telefonu)

Ciało (JSON)

PoleTypOpis
polaczeniaarray

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/polaczenia" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"polaczenia": ...}'
post/api/telefon/propozycje/{id}/odrzucOdrzucenie propozycji z rozmowy

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/propozycje/123/odrzuc" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/propozycje/{id}/przyjmijPrzyjecie propozycji z rozmowy (zadanie albo zmiana danych szansy)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/propozycje/123/przyjmij" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/rozmowa/{id}Transkrypcja z mowcami, slowa kluczowe, ocena i propozycje jednej rozmowy

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/rozmowa/123" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/rozmowa/{id}/ocenaOcena podsumowania rozmowy: trafne albo do_poprawki

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Ciało (JSON)

PoleTypOpis
ocenastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/rozmowa/123/ocena" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ocena": ...}'
post/api/telefon/rozmowa/{id}/ocena_czlowiekaOcena rozmowy 0-100 wystawiona przez czlowieka

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Ciało (JSON)

PoleTypOpis
ocenainteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/rozmowa/123/ocena_czlowieka" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ocena": ...}'
post/api/telefon/rozmowa/{id}/szkic_mailaSzkic maila z ustaleniami rozmowy w kolejce akceptacji

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Ciało (JSON)

PoleTypOpis
wymusboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/rozmowa/123/szkic_maila" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wymus": ...}'
post/api/telefon/rozmowa/{id}/transkrybujTranskrypcja rozmowy na zadanie (po przekroczeniu miesiecznego limitu)

Parametry

NazwaGdzieTypWymagany
idadresintegertak
idzapytaniestringnie

Odpowiedzi

  • 202 Przyjęto do kolejki
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/rozmowa/123/transkrybuj" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/rozmowy/szukajSzukanie w tresci nagranych rozmow (fragment, sekunda segmentu, filtr slowa kluczowego)

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie
slowozapytaniestringnie
odzapytaniestringnie
dozapytaniestringnie
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/rozmowy/szukaj" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/rozmowy/trafnoscTrafnosc podsumowan rozmow tydzien po tygodniu i zgodnosc oceny wg skryptu z ocena czlowieka

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/rozmowy/trafnosc" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/rozmowy/zuzycieZuzycie miesiaca na rozmowy: minuty, koszt transkrypcji i modelu, limit

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/rozmowy/zuzycie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/smsWatek SMS z telefonu doradcy dla szansy

Parametry

NazwaGdzieTypWymagany
lead_idzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/sms" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/smsWgranie SMS-ow z telefonu doradcy (idempotentnie po id z telefonu; tylko numery znanych szans)

Ciało (JSON)

PoleTypOpis
wiadomosciarray

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/sms" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wiadomosci": ...}'
post/api/telefon/stanStan synchronizacji danych w telefonie doradcy (do dziennika uslugi)

Ciało (JSON)

PoleTypOpis
wlaczoneboolean

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/telefon/stan" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wlaczone": ...}'
get/api/telefon/statystykiPolaczenia per doradca i czas oczekiwania klienta

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/telefon/statystyki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/telefon/zdrowieRaport z telefonow: urzadzenia z ocena i podsumowanie

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/telefon/zdrowie" \
  -H "Authorization: Bearer $KLUCZ"
post/api/telefon/zdrowieRaport zdrowia aplikacji Dzwonek z telefonu doradcy

Ciało (JSON)

PoleTypOpis
urzadzeniestring
powiadomieniastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/telefon/zdrowie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"urzadzenie": ..., "powiadomienia": ...}'
get/api/wejscie/{rodzaj}bez kluczaWeryfikacja webhooka Meta (Messenger, Instagram, WhatsApp, Lead Ads): hub.challenge

Parametry

NazwaGdzieTypWymagany
hub.modezapytaniestringnie
hub.verify_tokenzapytaniestringnie
hub.challengezapytaniestringnie
rodzajadresstringtak

Odpowiedzi

  • 200 OK
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/wejscie/<rodzaj>"
post/api/wejscie/{rodzaj}bez kluczaWejscie kanalu (messenger, instagram, whatsapp, meta_lead_ads, linkedin, allegro, olx, google_ads, centralka, p24) z podpisem albo sekretem kanalu

Parametry

NazwaGdzieTypWymagany
rodzajadresstringtak

Ciało (JSON)

PoleTypOpis
entryarray
zdarzeniaarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wejscie/<rodzaj>" \
  -H 'Content-Type: application/json' \
  -d '{"entry": ..., "zdarzenia": ...}'
post/api/zgloszeniebez kluczaWebhook formularza (naglowek x-fluxcrm-sekret)

Ciało (JSON)

PoleTypOpis
imiestring
emailstring
wiadomoscstring

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zgloszenie" \
  -H 'Content-Type: application/json' \
  -d '{"imie": ..., "email": ..., "wiadomosc": ...}'

Wersje API

get/api/wersjebez kluczaWersje API, daty wycofania i polityka wersjonowania (publiczne)

Odpowiedzi

  • 200 OK

Przykład

curl -sS -X GET "$CRM/api/wersje"

Whatsapp

get/api/whatsapp/szablonyKatalog szablonow WhatsApp ze stanem zatwierdzenia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/whatsapp/szablony" \
  -H "Authorization: Bearer $KLUCZ"
post/api/whatsapp/szablonyNowy szablon WhatsApp (wersja robocza) albo zalozenie trzech domyslnych

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/whatsapp/szablony" \
  -H "Authorization: Bearer $KLUCZ"
post/api/whatsapp/szablony/synchronizujPobranie stanu szablonow z Meta

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/whatsapp/szablony/synchronizuj" \
  -H "Authorization: Bearer $KLUCZ"
post/api/whatsapp/szablony/{nazwa}/zglosZgloszenie szablonu do zatwierdzenia w Meta

Parametry

NazwaGdzieTypWymagany
nazwazapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X POST "$CRM/api/whatsapp/szablony/<nazwa>/zglos" \
  -H "Authorization: Bearer $KLUCZ"
get/api/whatsapp/transportDecyzja o transporcie WhatsApp (Cloud API a sesja), koszt i lista pilota

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/whatsapp/transport" \
  -H "Authorization: Bearer $KLUCZ"

Widoki listy

get/api/widokiZapisane widoki listy zalogowanego uzytkownika (nazwa, filtry, domyslny)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/widoki" \
  -H "Authorization: Bearer $KLUCZ"
post/api/widokiZapis widoku pod nazwa (nadpisuje widok o tej samej nazwie), opcjonalnie jako domyslny

Ciało (JSON)

PoleTypOpis
nazwastring
daneobject
domyslnyboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/widoki" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "dane": ..., "domyslny": ...}'
put/api/widoki/{id}Zmiana nazwy, filtrow albo domyslnego widoku (domyslny true/false)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
nazwastring
daneobject
domyslnyboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/widoki/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"nazwa": ..., "dane": ..., "domyslny": ...}'
delete/api/widoki/{id}Usuniecie widoku uzytkownika

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X DELETE "$CRM/api/widoki/123" \
  -H "Authorization: Bearer $KLUCZ"

Wizja

get/api/wizjaWizja: zasada, propozycje agentow do decyzji, skutecznosc per typ, KPI wlasnej sprzedazy

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wizja" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wizja/budzetKonwersje i koszty per kampania, propozycja przesuniecia budzetu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wizja/budzet" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wizja/dzienPodsumowanie dnia dla zespolu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wizja/dzien" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wizja/dzienZapis podsumowania dnia jako ogloszenia zespolu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wizja/dzien" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wizja/glosZgloszenie glosowe poza godzinami: szansa, zdarzenie i propozycja oddzwonienia

Ciało (JSON)

PoleTypOpis
numerstring
transkrypcjastring
nazwastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wizja/glos" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"numer": ..., "transkrypcja": ..., "nazwa": ...}'
get/api/wizja/prompterPrompter przed rozmowa z klientem

Parametry

NazwaGdzieTypWymagany
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/wizja/prompter" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wizja/propozycjePropozycje agentow (stan, lead)

Parametry

NazwaGdzieTypWymagany
stanzapytaniestringnie
leadzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/wizja/propozycje" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wizja/propozycjeDecyzja czlowieka o propozycji: akceptuj (wykonuje skutek) albo odrzuc z powodem; klucz API nie decyduje

Ciało (JSON)

PoleTypOpis
idinteger
akcjastring
powodstring
terminstring
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 502 Błąd usługi zewnętrznej

Przykład

curl -sS -X POST "$CRM/api/wizja/propozycje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"id": ..., "akcja": ..., "powod": ...}'
post/api/wizja/przebiegUruchomienie generatorow propozycji (idempotentne)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wizja/przebieg" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wizja/tlumaczTlumaczenie fragmentu rozmowy na zywo

Ciało (JSON)

PoleTypOpis
tekststring
nastring
kontekstarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/wizja/tlumacz" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "na": ..., "kontekst": ...}'
get/api/wizja/zatrudnienieObciazenie zespolu i rekomendacja zatrudnienia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wizja/zatrudnienie" \
  -H "Authorization: Bearer $KLUCZ"

Wsparcie

post/api/wsparcie/czatCzat wsparcia: pytanie do agenta (z bazy wiedzy), kolejna wiadomosc albo nie_pomoglo

Ciało (JSON)

PoleTypOpis
trescstring
zgloszeniestring

Odpowiedzi

  • 200 OK
  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/czat" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ..., "zgloszenie": ...}'
get/api/wsparcie/faqFAQ bledow: wpisy pasujace do statusu, komunikatu albo pytania

Parametry

NazwaGdzieTypWymagany
qzapytaniestringnie
statuszapytaniestringnie
powodzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/wsparcie/faq" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wsparcie/incydentyRejestr incydentow (wlasciciel: pelny, inni: publiczne)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wsparcie/incydenty" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wsparcie/incydentyNowy incydent (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
tytulstring
wagastring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/incydenty" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "waga": ...}'
get/api/wsparcie/incydenty/retroZalegle retro, otwarte dzialania i MTTR (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/wsparcie/incydenty/retro" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wsparcie/incydenty/szablon-retroSzablon pytan retrospekcji incydentu

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wsparcie/incydenty/szablon-retro" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wsparcie/incydenty/{numer}/aktualizacjaAktualizacja incydentu i zmiana statusu

Ciało (JSON)

PoleTypOpis
tekststring
statusstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/incydenty/<numer>/aktualizacja" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tekst": ..., "status": ...}'
post/api/wsparcie/incydenty/{numer}/dzialanieOznaczenie dzialania z retro jako wykonanego

Ciało (JSON)

PoleTypOpis
numerinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/incydenty/<numer>/dzialanie" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"numer": ...}'
post/api/wsparcie/incydenty/{numer}/retroZapis retrospekcji incydentu

Ciało (JSON)

PoleTypOpis
przyczynastring
wnioskistring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/incydenty/<numer>/retro" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"przyczyna": ..., "wnioski": ...}'
get/api/wsparcie/metrykiCzas reakcji wsparcia, odsetek w SLA i rozwiazania automatu (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/wsparcie/metryki" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wsparcie/przerwyPlanowane przerwy trwajace i przyszle

Parametry

NazwaGdzieTypWymagany
wszystkiezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wsparcie/przerwy" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wsparcie/przerwyZapowiedz przerwy serwisowej (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
tytulstring
odstring
dostring

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/przerwy" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tytul": ..., "od": ..., "do": ...}'
post/api/wsparcie/przerwy/{numer}Zmiana albo odwolanie przerwy (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
odwolajboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/przerwy/<numer>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"odwolaj": ...}'
post/api/wsparcie/zalegleAwans zgloszen po terminie SLA (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/wsparcie/zalegle" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wsparcie/zgloszeniaZgloszenia wsparcia konta (wlasciciel: wszystkie)

Parametry

NazwaGdzieTypWymagany
statuszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/wsparcie/zgloszenia" \
  -H "Authorization: Bearer $KLUCZ"
get/api/wsparcie/zgloszenia/{numer}Rozmowa wsparcia

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/wsparcie/zgloszenia/<numer>" \
  -H "Authorization: Bearer $KLUCZ"
post/api/wsparcie/zgloszenia/{numer}Odpowiedz czlowieka w rozmowie wsparcia (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
trescstring
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/zgloszenia/<numer>" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ..., "akcja": ...}'
post/api/wsparcie/zgloszenia/{numer}/eskalujPrzekazanie rozmowy czlowiekowi

Ciało (JSON)

PoleTypOpis
powodstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/wsparcie/zgloszenia/<numer>/eskaluj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"powod": ...}'

Własne pola sprawy

get/api/polaDefinicje pol wlasnych sprawy (klucz, tytul, typ, opcje)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/pola" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "pola": [
    {
      "klucz": "kanal_zgloszenia",
      "tytul": "Kanal zgloszenia",
      "typ": "lista",
      "opcje": [
        "telefon",
        "www"
      ]
    }
  ]
}

Zadania

post/api/spotkania/import_icsImport kalendarza ICS: spotkania z uczestnikami znanymi CRM

Ciało (JSON)

PoleTypOpis
icsstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/spotkania/import_ics" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"ics": ...}'
post/api/spotkania/{id}Odwolanie spotkania

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
akcjastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/spotkania/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ...}'
get/api/spotkania/{id}/zaproszenieZaproszenie ICS (METHOD:REQUEST albo CANCEL)

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/spotkania/123/zaproszenie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/zadaniaZadania wszystkich szans

Zakres klucza: moduł zadania, tryb odczyt.

Parametry

NazwaGdzieTypWymagany
zakreszapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X GET "$CRM/api/zadania" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "zakres": "wszystkie",
  "ile": 1,
  "ile_zaleglych": 0,
  "zadania": [
    {
      "id": 9,
      "lead_id": 17,
      "utworzono": "2026-10-28T09:21:00",
      "termin": "2026-10-30",
      "tresc": "Oddzwonic w sprawie oferty",
      "autor": "zapier",
      "zrobione": null,
      "zalegle": false,
      "priorytet": 2
    }
  ]
}
get/api/zadania/eksportEksport otwartych zadan: taskwarrior, todoist (CSV), ics

Parametry

NazwaGdzieTypWymagany
formatzapytaniestringnie
wszystkiezapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/zadania/eksport" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zadania/todoistZadania do Todoista przez REST (z tokenem w konfiguracji)

Ciało (JSON)

PoleTypOpis
wyslijboolean
wszystkieboolean

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X POST "$CRM/api/zadania/todoist" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"wyslij": ..., "wszystkie": ...}'
patch/api/zadania/{id}Zmiana zadania: zrobione, termin, tresc, przypisany, priorytet (id zadania)

Zakres klucza: moduł zadania, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
zrobioneboolean
terminstring
trescstring
przypisanystring | null
priorytetinteger
szacunek_mininteger | null
powtarzajstring | null
powtarzaj_cointeger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X PATCH "$CRM/api/zadania/123" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"zrobione": true}'

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "notatki": [],
  "zadania": [
    {
      "id": 9,
      "lead_id": 17,
      "utworzono": "2026-10-28T09:21:00",
      "termin": "2026-10-30",
      "tresc": "Oddzwonic w sprawie oferty",
      "autor": "zapier",
      "zrobione": "2026-10-28T10:00:00",
      "zalegle": false,
      "priorytet": 2
    }
  ],
  "id": 9
}
delete/api/zadania/{id}Usuniecie zadania (id zadania)

Zakres klucza: moduł zadania, tryb zapis.

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X DELETE "$CRM/api/zadania/123" \
  -H "Authorization: Bearer $KLUCZ"

Przykładowa odpowiedź

{
  "ok": true,
  "lead_id": 17,
  "notatki": [],
  "zadania": [],
  "id": 9
}
post/api/zadania/{id}/delegujPrzypisanie zadania innej osobie z komentarzem

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
komustring
komentarzstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zadania/123/deleguj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"komu": ..., "komentarz": ...}'
post/api/zadania/{id}/komentarzeKomentarz pod zadaniem

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring
rodzic_idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zadania/123/komentarze" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ..., "rodzic_id": ...}'
post/api/zadania/{id}/pozycjePozycja checklisty w zadaniu

Parametry

NazwaGdzieTypWymagany
idadresintegertak

Ciało (JSON)

PoleTypOpis
trescstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zadania/123/pozycje" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tresc": ...}'

Zdrowie klienta

get/api/zdrowie_klientaPomiar zdrowia klienta z 14 dni (logowania, leady, odpowiedzi, dni bez aktywnosci) dla operatora

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/zdrowie_klienta" \
  -H "Authorization: Bearer $KLUCZ"

Zespoly

get/api/zespolyZespoly z kierownikami i czlonkami (wlasciciel: wszystkie, inni: swoje)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/zespoly" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zespolyZespol: akcja zapisz (nazwa, kierownik, czlonkowie) albo usun (wlasciciel)

Ciało (JSON)

PoleTypOpis
akcjastring
nazwastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zespoly" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "nazwa": ...}'

Zespół i przydział

get/api/zespolZespol: opiekunowie, tryb przydzialu, doradcy, nieobecnosci

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/zespol" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zespolZapis przydzialu: tryb, doradcy, wg_zrodla, nieobecni (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
trybstring
doradcyarray
wg_zrodlaobject
nieobecniarray

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zespol" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"tryb": ..., "doradcy": ..., "wg_zrodla": ...}'
get/api/zespol/kanalyMoje kanaly powiadomien poza panelem

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/zespol/kanaly" \
  -H "Authorization: Bearer $KLUCZ"
put/api/zespol/kanalyCzat Telegram konta

Ciało (JSON)

PoleTypOpis
telegram_czatstring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X PUT "$CRM/api/zespol/kanaly" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"telegram_czat": ...}'
post/api/zespol/kanaly/rozeslijRozeslanie nowych powiadomien skrzynki (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X POST "$CRM/api/zespol/kanaly/rozeslij" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zespol/kanaly/testWiadomosc probna na kanaly instancji

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X POST "$CRM/api/zespol/kanaly/test" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zespol/nieobecnosciDodanie albo usuniecie nieobecnosci doradcy (tylko wlasciciel)

Ciało (JSON)

PoleTypOpis
akcjastring
opiekunstring
odstring
dostring
idinteger

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zespol/nieobecnosci" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"akcja": ..., "opiekun": ..., "od": ...}'
get/api/zespol/wiadomosciNotatki glosowe i wideo miedzy czlonkami zespolu

Parametry

NazwaGdzieTypWymagany
zzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/zespol/wiadomosci" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zespol/wiadomosciWyslanie notatki glosowej albo wideo koledze

Ciało (JSON)

PoleTypOpis
adresatstring
rodzajstring
typstring
dane_base64string

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 413 Content Too Large
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zespol/wiadomosci" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"adresat": ..., "rodzaj": ..., "typ": ...}'

Zglos blad

post/api/zglos_bladZgloszenie bledu z panelu jednym kliknieciem (kontekst z bialej listy, bez danych klientow)

Ciało (JSON)

PoleTypOpis
opisstring
kontekstobject

Odpowiedzi

  • 201 Utworzono
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi
  • 429 Za dużo prób, patrz Retry-After

Przykład

curl -sS -X POST "$CRM/api/zglos_blad" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"opis": ..., "kontekst": ...}'

Zgloszenia bledow

get/api/zgloszenia_bledowZgloszenia bledow z panelu (wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/zgloszenia_bledow" \
  -H "Authorization: Bearer $KLUCZ"

Zgodnosc

get/api/zgodnosc/dostepDziennik dostepu do danych wrazliwych (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
loginzapytaniestringnie
lead_idzapytaniestringnie
kategoriazapytaniestringnie
dnizapytaniestringnie
limitzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/zgodnosc/dostep" \
  -H "Authorization: Bearer $KLUCZ"
get/api/zgodnosc/dostep/eksportEksport dziennika dostepu (csv, xlsx, pdf) z tymi samymi filtrami; sam jest wpisem w dzienniku (tylko wlasciciel)

Parametry

NazwaGdzieTypWymagany
formatzapytaniestringnie
loginzapytaniestringnie
lead_idzapytaniestringnie
kategoriazapytaniestringnie
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi
  • 501 Not Implemented
  • 503 Funkcja wyłączona lub niedostępna

Przykład

curl -sS -X GET "$CRM/api/zgodnosc/dostep/eksport" \
  -H "Authorization: Bearer $KLUCZ"
get/api/zgodnosc/dostep/podsumowaniePodsumowanie dostepu do danych wrazliwych wg kont i alerty masowego odczytu

Parametry

NazwaGdzieTypWymagany
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X GET "$CRM/api/zgodnosc/dostep/podsumowanie" \
  -H "Authorization: Bearer $KLUCZ"
get/api/zgodnosc/ksefGotowosc faktur do KSeF: przeglad albo kontrola i szkic FA(3) jednej faktury (numer)

Parametry

NazwaGdzieTypWymagany
numerzapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)
  • 404 Nie znaleziono

Przykład

curl -sS -X GET "$CRM/api/zgodnosc/ksef" \
  -H "Authorization: Bearer $KLUCZ"
get/api/zgodnosc/lokalizacjaLokalizacja danych instancji i funkcje wysylajace dane poza serwer

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/zgodnosc/lokalizacja" \
  -H "Authorization: Bearer $KLUCZ"
get/api/zgodnosc/szyfrowanieSzyfrowanie danych w spoczynku: wolumen, kopie .fxe i sekrety (tylko wlasciciel)

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 403 Brak uprawnień (np. klucz odczytu)

Przykład

curl -sS -X GET "$CRM/api/zgodnosc/szyfrowanie" \
  -H "Authorization: Bearer $KLUCZ"

Zgody RODO

get/api/zgodyRodzaje i zrodla zgod RODO oraz czy instancja ostrzega o braku zgody

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/zgody" \
  -H "Authorization: Bearer $KLUCZ"

Zyczenia

get/api/zyczeniaNadchodzace okazje i swieta do zyczen

Parametry

NazwaGdzieTypWymagany
datazapytaniestringnie
dnizapytaniestringnie

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja

Przykład

curl -sS -X GET "$CRM/api/zyczenia" \
  -H "Authorization: Bearer $KLUCZ"
post/api/zyczenia/generujSzkice zyczen na dzien (urodziny, rocznice, swieta); nic nie wychodzi

Ciało (JSON)

PoleTypOpis
datastring

Odpowiedzi

  • 200 OK
  • 401 Brak lub zły klucz albo sesja
  • 422 Błędne dane, powód w odpowiedzi

Przykład

curl -sS -X POST "$CRM/api/zyczenia/generuj" \
  -H "Authorization: Bearer $KLUCZ" \
  -H 'Content-Type: application/json' \
  -d '{"data": ...}'