Developers
Build on RapBooster with the public API.
RapBooster's REST API lets any site, app or server sell from a workspace's store, work with leads and contacts, send WhatsApp and email, and receive signed webhooks. API keys are free in every workspace, and the typed @rapbooster/sdk covers every endpoint.
Start the Free plan, then create a key in Settings.
- Free API keys
- 300 requests a minute
- Signed webhooks
- Test keys
curl https://api.rapbooster.com/api/v1/public/v1/crm/leads \
-H "Authorization: Bearer rb_live_..." \
-H "Content-Type: application/json" \
-d '{ "name": "Asha Verma", "mobile": "+919876543210" }'
Quick start
From key to first call in three steps
- 1. Create a keyIn Settings › Developer, name it and pick its scopes. A secret key is shown once; a publishable key for a site or app can be shown again.
- 2. Call the APISend it as a bearer token. A key acts as the member who made it, never more.
- 3. Listen for eventsAdd an https endpoint and receive signed lead and message events as they happen.
Store API
Sell from your own site or app
The Store API serves a workspace's catalogue, buyer accounts (phone code, Google, Apple), carts, Razorpay checkout, orders, subscriptions, reviews and trade accounts under /public/v1/store. Use a publishable key in the browser or app and send the signed-in buyer's X-Buyer-Token.
curl "https://api.rapbooster.com/api/v1/public/v1/store/products?limit=12" \
-H "Authorization: Bearer rb_pk_live_..."
Docs
Reference and guides
Authentication
Scopes keep every key to its job
Every call needs the key's scope and the creating member's own right to the same thing. App endpoints also need the workspace id in x-workspace-id. Keys are stored only as a hash. A publishable key (rb_pk_…) holds only storefront and answers only its allowed origins.
App scopes
crm:readCRM leads, their counts and lead statusesmarketing:readAudience contacts and groups, social accounts and postsmarketing:writeCreate and schedule social postsinbox:readThe social inboxbilling:readInvoices and credit notesstore:readStore items, orders, settings and Store syncstore:writeCreate, change and delete store itemssupport:readSupport tickets and categoriesorders:readOrders and their summary
Public API v1 scopes
crm:readRead leadscrm:writeCreate and update leadsmarketing:readRead contactsmarketing:writeCreate and update contactsinbox:writeSend WhatsApp and emailinbox:readRead a message's delivery statuswebhooks:manageAdd, change and delete webhook endpointsstorefrontThe Store API (the one scope a publishable key holds)
- 300 requests a minutePer key. Over that you get 429 with code PUBLIC_API_RATE_LIMITED.
- Keys are freeSending costs what the same send costs in the app; email goes through your own mailbox.
- Test keysAn rb_test_ key reads real data, makes dry-run sends and refuses every other change.
- Predictable shapessnake_case fields. A record is { data }, a list { items, meta }, an error { code, message, details?, correlation_id }.
Endpoints
Every endpoint, from the live document
Read from the API's own OpenAPI document, so this list never drifts from what runs. Paths start after the API base (https://api.rapbooster.com/api/v1); open one for its parameters and a Try it panel.
Store API60 endpoints
GET
/Stablepublic/ v1/ store The store: name, legal and support details, checkout and shipping settings
POST
/Stablepublic/ v1/ store/ auth/ apple Sign in with an Apple ID token
POST
/Stablepublic/ v1/ store/ auth/ google Sign in with a Google ID token
POST
/Stablepublic/ v1/ store/ auth/ logout End the session of a refresh token
POST
/Stablepublic/ v1/ store/ auth/ otp Send a sign-in code to a phone
POST
/Stablepublic/ v1/ store/ auth/ otp/ verify Check the code: signs the buyer in (or up)
POST
/Stablepublic/ v1/ store/ auth/ refresh Swap a refresh token for a new pair (the old one stops working)
DELETE
/Stablepublic/ v1/ store/ buyers/ {id} Erase a buyer's account; orders keep their tax records
GET
/Stablepublic/ v1/ store/ buyers/ {id} A buyer
PUT
/Stablepublic/ v1/ store/ buyers/ {id}/ groups Set a buyer's groups (offer eligibility, e.g. patron)
POST
/Stablepublic/ v1/ store/ carts Start a cart (attached to the buyer when signed in)
GET
/Stablepublic/ v1/ store/ carts/ {cartId} A cart, priced now
POST
/Stablepublic/ v1/ store/ carts/ {cartId}/ attach Attach a guest cart to the signed-in buyer (merged into their open cart)
DELETE
/Stablepublic/ v1/ store/ carts/ {cartId}/ coupon Remove the coupon
POST
/Stablepublic/ v1/ store/ carts/ {cartId}/ coupon Apply a coupon code
PUT
/Stablepublic/ v1/ store/ carts/ {cartId}/ delivery Set the delivery address or PIN code (shipping fee, ETA)
PUT
/Stablepublic/ v1/ store/ carts/ {cartId}/ gift Mark the order a gift, with a message
PUT
/Stablepublic/ v1/ store/ carts/ {cartId}/ lines Replace the cart's lines
GET
/Stablepublic/ v1/ store/ categories The store's categories
POST
/Stablepublic/ v1/ store/ checkout Place the order: Razorpay order to pay in-page, or trade credit
POST
/Stablepublic/ v1/ store/ checkout/ {number}/ confirm Confirm the in-page Razorpay payment (signature check)
GET
/Stablepublic/ v1/ store/ feeds/ merchant.xml Google Merchant Center feed (RSS 2.0) of the visible products
GET
/Stablepublic/ v1/ store/ me The signed-in buyer
PATCH
/Stablepublic/ v1/ store/ me Change the buyer's name, email or consents
GET
/Stablepublic/ v1/ store/ me/ addresses The buyer's addresses
POST
/Stablepublic/ v1/ store/ me/ addresses Add an address
DELETE
/Stablepublic/ v1/ store/ me/ addresses/ {id} Delete an address
PATCH
/Stablepublic/ v1/ store/ me/ addresses/ {id} Change an address
GET
/Stablepublic/ v1/ store/ me/ claims The buyer's claims, newest first
POST
/Stablepublic/ v1/ store/ me/ deletion-request Ask the store to delete the buyer's account (nothing is deleted now)
POST
/Stablepublic/ v1/ store/ me/ devices Register an app install for push
DELETE
/Stablepublic/ v1/ store/ me/ devices/ {token} Forget an app install
POST
/Stablepublic/ v1/ store/ me/ export Email the buyer a JSON export of their data within 24 h (once a day)
GET
/Stablepublic/ v1/ store/ me/ orders The buyer's orders, newest first
GET
/Stablepublic/ v1/ store/ me/ orders/ {number} One order with its shipments, claims and invoice
POST
/Stablepublic/ v1/ store/ me/ orders/ {number}/ claims Report a damaged, wrong or missing item
GET
/Stablepublic/ v1/ store/ me/ orders/ {number}/ invoice A signed link (10 minutes) to the order's GST invoice PDF
POST
/Stablepublic/ v1/ store/ me/ orders/ {number}/ reorder Put the order's items in the buyer's cart again
GET
/Stablepublic/ v1/ store/ me/ reviews The buyer's reviews
POST
/Stablepublic/ v1/ store/ me/ reviews Review a delivered product (status pending until moderated)
GET
/Stablepublic/ v1/ store/ me/ subscriptions The buyer's subscriptions
POST
/Stablepublic/ v1/ store/ me/ subscriptions Subscribe; returns the Razorpay ids
PATCH
/Stablepublic/ v1/ store/ me/ subscriptions/ {id} Change a box's interval, lines or address
POST
/Stablepublic/ v1/ store/ me/ subscriptions/ {id}/ cancel Cancel a subscription
POST
/Stablepublic/ v1/ store/ me/ subscriptions/ {id}/ pause Pause a subscription
POST
/Stablepublic/ v1/ store/ me/ subscriptions/ {id}/ resume Resume a paused subscription
POST
/Stablepublic/ v1/ store/ me/ subscriptions/ {id}/ skip Skip the next delivery
GET
/Stablepublic/ v1/ store/ me/ trade The buyer's trade account
POST
/Stablepublic/ v1/ store/ me/ trade/ apply Apply for a trade account with a GSTIN
GET
/Stablepublic/ v1/ store/ me/ trade/ ledger The trade account's ledger: invoices, payments, credit notes
POST
/Stablepublic/ v1/ store/ me/ uploads Upload a photo for a claim or a review
GET
/Stablepublic/ v1/ store/ me/ wishlist The buyer's wishlist
DELETE
/Stablepublic/ v1/ store/ me/ wishlist/ {productId} Remove a product from the wishlist
PUT
/Stablepublic/ v1/ store/ me/ wishlist/ {productId} Add a product to the wishlist
GET
/Stablepublic/ v1/ store/ policies/ {kind} One policy page (refund, shipping, terms, privacy, returns)
GET
/Stablepublic/ v1/ store/ products Visible products
GET
/Stablepublic/ v1/ store/ products/ {slug} One product with its variants (an approved trade buyer sees trade prices)
GET
/Stablepublic/ v1/ store/ products/ {slug}/ reviews A product's published reviews
GET
/Stablepublic/ v1/ store/ shipping/ quote Is the PIN code served, the fee, free-above and the ETA
GET
/Stablepublic/ v1/ store/ subscription-plans What a buyer may subscribe to: box intervals and recurring catalogue prices
Public API: Contacts4 endpoints
GET
/Stablepublic/ v1/ marketing/ contacts List people
POST
/Stablepublic/ v1/ marketing/ contacts Add a person: a known email or phone returns that person
GET
/Stablepublic/ v1/ marketing/ contacts/ {id} Get a person
PATCH
/Stablepublic/ v1/ marketing/ contacts/ {id} Update a person
Public API: Leads4 endpoints
GET
/Stablepublic/ v1/ crm/ leads List leads
POST
/Stablepublic/ v1/ crm/ leads Create a lead (owned by the key's creator)
GET
/Stablepublic/ v1/ crm/ leads/ {id} Get a lead
PATCH
/Stablepublic/ v1/ crm/ leads/ {id} Update a lead's name, mobile, email, status or location
Public API: Messages3 endpoints
GET
/Stablepublic/ v1/ inbox/ messages/ {channel}/ {id} A sent message's delivery status
POST
/Stablepublic/ v1/ inbox/ messages/ email Send one email from a connection (default: the system one)
POST
/Stablepublic/ v1/ inbox/ messages/ whatsapp Send an approved WhatsApp template to a number
Public API: Webhooks4 endpoints
GET
/Stablepublic/ v1/ webhook-endpoints List webhook endpoints
POST
/Stablepublic/ v1/ webhook-endpoints Add an endpoint (https): its signing secret is in this response only
DELETE
/Stablepublic/ v1/ webhook-endpoints/ {id} Delete an endpoint
PATCH
/Stablepublic/ v1/ webhook-endpoints/ {id} Change an endpoint's URL or events, or turn it off and on
Billing: Invoices4 endpoints
GET
/Beta · billing:readbilling/ invoices List quotes, proformas and tax invoices
GET
/Beta · billing:readbilling/ invoices/ {id} One document with its lines
GET
/Beta · billing:readbilling/ invoices/ credit-notes List credit notes (optionally for one invoice)
GET
/Beta · billing:readbilling/ invoices/ credit-notes/ {id} One credit note with its lines
Billing: Offers5 endpoints
GET
/Beta · billing:readbilling/ offers Offers with their uses, revenue and discount cost
GET
/Beta · billing:readbilling/ offers/ {id} One offer
GET
/Beta · billing:readbilling/ offers/ {id}/ codes The offer's codes
GET
/Beta · billing:readbilling/ offers/ {id}/ redemptions Where the offer was used, newest first
GET
/Beta · billing:readbilling/ offers/ {id}/ report The offer's report: uses, revenue, discount cost, per channel and per day (30 days)
Contact Groups2 endpoints
GET
/Beta · marketing:readmarketing/ audience/ groups List groups (the Contacts home table)
GET
/Beta · marketing:readmarketing/ audience/ groups/ {id} Get a group (metadata, fields and usage)
Contacts2 endpoints
GET
/Beta · marketing:readmarketing/ audience/ contacts All contacts (searched, filtered, sorted)
GET
/Beta · marketing:readmarketing/ audience/ contacts/ {id} Get a contact
Leads3 endpoints
GET
/Beta · crm:readcrm/ leads List leads
GET
/Beta · crm:readcrm/ leads/ {id} Get a lead with its default billing detail and header fields
GET
/Beta · crm:readcrm/ leads/ counts How many leads are in each status and each sidebar view
Leads: Settings1 endpoint
GET
/Beta · crm:readcrm/ leads/ lead-statuses The workspace's lead statuses, in its order (removed ones on request)
Orders3 endpoints
GET
/Beta · orders:readorders List goods orders
GET
/Beta · orders:readorders/ {id} An order with its lines and shipments
GET
/Beta · orders:readorders/ summary Overview and sidebar counts: to ship, shipped in 7 days, delivered, cancelled, to pack, ready to ship, in transit, issues, returns, COD to collect
Site API: CRM1 endpoint
POST
/Stablepublic/ v1/ crm/ enquiries Send a site form (contact, service, corporate gifting, trade, franchise, careers)
Site API: HRMS5 endpoints
POST
/Stablepublic/ v1/ hrms/ applications Apply to an open role (CV as a PDF, at most 5 MB)
POST
/Stablepublic/ v1/ hrms/ applications/ otp Send a code to the applicant's phone (careers form)
POST
/Stablepublic/ v1/ hrms/ applications/ otp/ verify Check the code: answers a single-use phone-verified token (30 minutes)
GET
/Stablepublic/ v1/ hrms/ jobs Open roles, newest first, with the JobPosting fields
GET
/Stablepublic/ v1/ hrms/ jobs/ {slug} One open role
Site API: Marketing4 endpoints
GET
/Stablepublic/ v1/ marketing/ campaigns Campaigns with their status and counts
DELETE
/Stablepublic/ v1/ marketing/ subscriptions Opt a person out of an Audience group
POST
/Stablepublic/ v1/ marketing/ subscriptions Opt a person in to an Audience group, with the consent they gave
GET
/Stablepublic/ v1/ marketing/ templates Approved WhatsApp templates and ready email templates
Site API: Workspace1 endpoint
GET
/Stablepublic/ v1/ workspace/ profile Company facts: legal and brand name, CIN, GSTIN, address, logo, socials, hours
Social7 endpoints
GET
/Beta · marketing:readsocial/ accounts Connected accounts (with health) and the plan's Social accounts allowance
GET
/Beta · inbox:readsocial/ inbox Inbox threads
GET
/Beta · inbox:readsocial/ inbox/ {id} One thread with its messages
GET
/Beta · marketing:readsocial/ posts Posts
POST
/Beta · marketing:writesocial/ posts Save a new draft
GET
/Beta · marketing:readsocial/ posts/ {id} One post with its accounts' states
POST
/Beta · marketing:writesocial/ posts/ {id}/ schedule Schedule (a time, the next queue slot, or now), or send for approval
Store7 endpoints
GET
/Beta · store:readstore/ items The store's items
POST
/Beta · store:writestore/ items Add catalogue items to the store
DELETE
/Beta · store:writestore/ items/ {id} Take an item off the store (the catalogue item stays)
PATCH
/Beta · store:writestore/ items/ {id} Show or hide, action, per-item delivery, order, featured
GET
/Beta · store:readstore/ orders Store orders, newest first (search: buyer, number, phone)
GET
/Beta · store:readstore/ orders/ {id} One store order, with its payments and shipping
GET
/Beta · store:readstore/ settings The store's settings (defaults until first saved)
Store: Marketplaces12 endpoints
GET
/Beta · store:readstore/ marketplaces/ accounts The workspace's seller accounts
GET
/Beta · store:readstore/ marketplaces/ accounts/ {id} One seller account
GET
/Beta · store:readstore/ marketplaces/ accounts/ {id}/ runs The account's run log, newest first
GET
/Beta · store:readstore/ marketplaces/ health An account's health: status, the latest snapshot and the last 30 days
GET
/Beta · store:readstore/ marketplaces/ invoices Amazon's GST invoices and credit notes
GET
/Beta · store:readstore/ marketplaces/ listings Listings
GET
/Beta · store:readstore/ marketplaces/ orders Marketplace orders
GET
/Beta · store:readstore/ marketplaces/ orders/ {id} One marketplace order: lines, store and goods order, Amazon Custom data and files
GET
/Beta · store:readstore/ marketplaces/ returns Marketplace returns
GET
/Beta · store:readstore/ marketplaces/ returns/ {id} One marketplace return
GET
/Beta · store:readstore/ marketplaces/ settlements Marketplace settlements (payouts), with sums by group and exception counts
GET
/Beta · store:readstore/ marketplaces/ settlements/ {id} One settlement: its lines grouped by order, expected vs paid, exception flags
Store: Sync6 endpoints
GET
/Beta · store:readstore/ sync/ conflicts Sync conflicts
GET
/Beta · store:readstore/ sync/ connections The workspace's sync connections
GET
/Beta · store:readstore/ sync/ connections/ {id} One sync connection
GET
/Beta · store:readstore/ sync/ connections/ {id}/ links A connection's linked items
GET
/Beta · store:readstore/ sync/ connections/ {id}/ runs A connection's run log
GET
/Beta · store:readstore/ sync/ runs/ {id} One run with its report (what a dry run would change)
Support3 endpoints
GET
/Beta · support:readsupport/ categories List ticket categories
GET
/Beta · support:readsupport/ tickets List tickets
GET
/Beta · support:readsupport/ tickets/ {id} Read a ticket and its whole thread, internal notes included
Webhooks
Signed events, retried until you answer
Events include store.order.paid, shipped, delivered, cancelled and refunded, store.subscription.changed, store.buyer.created and deleted, inventory.stock.low, crm.enquiry.created, lead.created, lead.updated, message.status and more (the full list is in Settings and the webhooks guide). Each POST is signed with HMAC-SHA256 of “<t>.<raw body>” and your endpoint's secret: verify it on the raw body, refuse an old timestamp.
POST https://your-app.example/hooks/rapbooster
X-RapBooster-Event: lead.created
X-RapBooster-Signature: t=1767225600,v1=5f2c…
{
"id": "evt_9c1e…",
"event": "lead.created",
"created_at": "2026-10-30T09:12:45Z",
"data": { "id": "4182", "name": "Asha Verma" }
}
Downloads
OpenAPI, Postman and SDKs
Generated from the same document as the list above, so they never drift.
Changelog
Changes and deprecations
Stable endpoints never break without 90 days' notice here; Beta endpoints may change, also listed here.
Store API, publishable keys and the SDK
The Store API (public/v1/store: catalogue, buyer sign-in, carts, Razorpay checkout, orders, subscriptions, reviews, trade accounts) with publishable keys (rb_pk_…) for sites and apps, store webhooks (store.order.paid and 13 more), the API reference with Try it, guides, and @rapbooster/sdk 0.2 with typed helpers. Settings › Developer is now its own permission.
New paths and scope names
Breaking: public/v1/leads is now public/v1/crm/leads, public/v1/contacts is public/v1/marketing/contacts and public/v1/messages is public/v1/inbox/messages. The scopes leads:* and contacts:* are now crm:* and marketing:*, and the app scopes follow the apps: crm, marketing, inbox and billing. Keys you already have keep working with their scopes renamed; change the paths in your code.
Platform API
App endpoints for leads, contacts, sales, support and orders (Beta), test keys, Idempotency-Key, IP allow-lists, key expiry and rolling, a request log, platform webhooks with a delivery log, resend and secret rotation. Webhooks now retry for 3 days.
Public API v1
Leads, contacts, WhatsApp and email sends, delivery status and webhooks. Stable.
Questions
About the API
What is a publishable key?
A key you may ship inside a website or a mobile app. It opens only the Store API, answers only the origins you list (exact https origins; http://localhost on test keys) and can be shown again in Settings. Secret keys stay on servers.
Who can create keys and webhooks?
The workspace owner and any member whose role holds Developer (Settings › Developer). A key acts as the member who made it and stops if they lose that permission.
Does the API cost extra?
No. API keys are free in every workspace. A WhatsApp or email sent through the API costs what the same send costs in the app.
What can a key do?
Only what its scopes allow and only what the member who created it may do. Revoke a key in Settings and it stops at once.
How are webhook deliveries retried?
A non-2xx answer or a network error is retried with growing gaps (30 seconds, then doubling up to 12 hours) for 3 days. Each event has a stable id so you can ignore repeats. An endpoint that keeps failing for 3 days is turned off and the workspace is emailed; resend any delivery from the delivery log.
How do I rotate a webhook secret or an API key?
Rotate the secret in Settings: for 24 hours each delivery carries two v1= signatures, one per secret, so you can switch without missing one. Roll a key the same way: the old one keeps working for 24 hours.
What if my request is retried?
Send an Idempotency-Key header on a POST or PATCH. A retry within 24 hours gets the first answer again (Idempotent-Replayed: true); the same key with a different body is refused with 422.
Is there a daily limit?
Each key may make 300 requests a minute. Your plan may also set requests a day for the whole workspace; past it, calls get 429 PUBLIC_API_DAILY_CAP until midnight IST.
What do Stable and Beta mean?
Stable endpoints never break: a breaking change gets a new path and 90 days' notice in the changelog. Beta endpoints may still change, announced in the changelog.
Is there an SMS endpoint?
No. The API covers leads, contacts, WhatsApp and email sends, delivery status and webhooks.
Get your free API key.
Start the Free plan, then create a key in Settings. No card needed.
Prefer a walkthrough? Book a demo