Skip to content

Sales leads

GET/api/v1/firsatlar

Sales leads the assistant opened during calls (customers who agreed to be contacted), newest first; filter by sinif (sicak hot, ilik warm, soguk cold), durum and since. Phone, name and email are masked unless you enabled personal data in the Data API. For CRM sync, pair it with the firsat.olusturuldu webhook.

  • Authentication: Authorization: Bearer rz_live_…
  • Scope: firsat:read
  • Plan feature: Data API + Sales leads — if off, the endpoint answers 404 not_found
NameInTypeLimitsMeaning
durumquery"yeni" | "iletisimde" | "teklif" | "kazanildi" | "kaybedildi" | nullStatus filter: for carts e.g. terk (abandoned); for leads yeni, iletisimde, teklif, kazanildi, kaybedildi.
sinifquery"sicak" | "ilik" | "soguk" | nullLead class: sicak (hot), ilik (warm), soguk (cold).
sincequerystring (date-time) | nullFrom this moment on (ISO 8601).
cursorquerystring | nullnext_cursor from the previous response.
limitqueryinteger≥ 1, ≤ 100, default 50Page size.
Terminal window
curl -s "$RZ_API/api/v1/firsatlar?sinif=sicak&limit=50" -H "Authorization: Bearer $RZ_KEY"

Error statuses: 401, 403, 404, 413, 422, 429 — see Errors and limits.


GET/api/v1/firsatlar/{lead_id}

A single sales lead; fields and masking as in the list. Leads from test calls return 404.

  • Authentication: Authorization: Bearer rz_live_…
  • Scope: firsat:read
  • Plan feature: Data API + Sales leads — if off, the endpoint answers 404 not_found
NameInTypeLimitsMeaning
lead_id *pathstring (uuid)Sales lead id (UUID).
Terminal window
curl -s "$RZ_API/api/v1/firsatlar/0199…" -H "Authorization: Bearer $RZ_KEY"

Error statuses: 401, 403, 404, 413, 422, 429 — see Errors and limits.