API Reference

Build anything on top of Barq

RESTful API, JWT authentication, sensible pagination. Fully documented with examples.

Base URL

https://api.barqcrm.co

Authentication 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 company

POST/api/auth/loginSign in with email and password

POST/api/auth/refreshExchange refresh token for new access token

POST/api/auth/logoutInvalidate current session

GET/api/customersList customers with pagination and filtersauth

POST/api/customersCreate a new customer recordauth

GET/api/customers/:idGet customer details by IDauth

PUT/api/customers/:idUpdate customer fieldsauth

DELETE/api/customers/:idDelete a customer (with cascade)auth

GET/api/dealsList deals with stage, value, and owner filtersauth

POST/api/dealsCreate a new dealauth

PUT/api/deals/:idUpdate deal (moving to won triggers commissions)auth

POST/api/whatsapp/webhookMeta Cloud webhook (public, no auth)

GET/api/whatsapp/inboxGrouped conversations with customer lookupauth

POST/api/whatsapp/sendSend message via Meta Graph APIauth

GET/api/reports/revenueWon revenue normalized to target currencyauth

GET/api/reports/pipelineOpen pipeline weighted by probabilityauth

GET/api/reports/ratesList configured exchange ratesauth

Full OpenAPI spec and interactive playground coming soon.