API Reference
Build anything on top of Zyrix
RESTful API, JWT authentication, sensible pagination. Fully documented with examples.
Base URL
https://api.crm.zyrix.coAuthentication header
Authorization: Bearer <token>Rate limits
Free plan: 60 requests/minute. Paid plans: 600+ requests/minute.
Authentication
POST
/api/auth/signupCreate a new account and companyPOST
/api/auth/loginSign in with email and passwordPOST
/api/auth/refreshExchange refresh token for new access tokenPOST
/api/auth/logoutInvalidate current sessionCustomers
GET
/api/customersList customers with pagination and filtersauthPOST
/api/customersCreate a new customer recordauthGET
/api/customers/:idGet customer details by IDauthPUT
/api/customers/:idUpdate customer fieldsauthDELETE
/api/customers/:idDelete a customer (with cascade)authDeals & Pipeline
GET
/api/dealsList deals with stage, value, and owner filtersauthPOST
/api/dealsCreate a new dealauthPUT
/api/deals/:idUpdate deal (moving to won triggers commissions)authPOST
/api/whatsapp/webhookMeta Cloud webhook (public, no auth)GET
/api/whatsapp/inboxGrouped conversations with customer lookupauthPOST
/api/whatsapp/sendSend message via Meta Graph APIauthReports
GET
/api/reports/revenueWon revenue normalized to target currencyauthGET
/api/reports/pipelineOpen pipeline weighted by probabilityauthGET
/api/reports/ratesList configured exchange ratesauthFull OpenAPI spec and interactive playground coming soon.
Documentation