Developers

Grocito CRM API

A REST API and signed webhooks to connect Grocito CRM with your website, app, ERP or billing system — JSON over HTTPS, keys you control, Indian mobile numbers handled for you.

Endpoints
30
Webhook events
14
Format
JSON
Version
v1
On this page

Overview

The Grocito CRM API lets your own software work with your CRM over HTTPS: add leads from your website or app, keep another system in step, or pull leads, deals, quotations, invoices and store orders into your own reports. Webhooks tell your server as soon as something changes.

  • Leads — list, find by mobile or email, create (with duplicate handling), update, archive and restore.
  • Notes, deals and reminders on a lead; mark reminders done.
  • Read call logs, team members and your CRM settings (statuses, sources, custom fields, deal stages).
  • Read quotations and invoices (Quotation Manager plugin) and online-store orders and customers (E-commerce plugin).
  • Webhooks for 14 events — signed, retried, with a delivery log in the CRM.

Who can use it

API & Webhooks is a plugin on paid plans — when your plan includes it, organisation admins see API & Webhooks in the CRM menu. Using the API costs nothing extra; each plan has a daily allowance:

API allowance by plan
PlanAPI calls a dayWebhooks
Starter2,0001
Growth10,0005
Pro / Business50,00010
Free trial500 (read-only)None

These are the standard limits; a plan or an organisation can be set up with different ones. GET /me shows the limits that apply to your key. See Pricing for the plans.

Get an API key

  1. Open API & Webhooks → Keys in the CRM, signed in as the organisation owner or an admin. Creating a key needs a sign-in within the last 10 minutes, and two-step verification applies if you use it.
  2. Choose what the key may do: a name, the team member it acts as, its scopes, when it expires (30, 90 or 365 days, or never) and, if you like, the IP addresses it may be used from. You can also choose how leads created with the key are assigned (round robin).
  3. Copy the key — it is shown once. Keep it in your server’s secret settings, never in a web page, mobile app or code repository.
  4. Rotate or revoke any time. Rotating gives a new secret and the old one stops working immediately — unless you tick Keep the old key working for 24 hours to switch over gently. Revoking stops the key at once. If a key has leaked, revoke it and create a new one.

An organisation can have up to 10 keys (2 on a trial).

Revoking or rotating a key takes effect within a few seconds. Blocking a member, changing their role, or suspending the organisation takes effect within 1 minute.

Authentication

Send the key in the Authorization header of every request, over HTTPS:

HTTP header
Authorization: Bearer YOUR_API_KEY
  • Keys look like grc_live_<key id>_<secret>. Only the Authorization: Bearer header is accepted.
  • A key sent in the URL (for example ?api_key=…) is refused with 400 key_in_query. Revoke that key and create a new one — addresses end up in logs.
  • A missing, wrong, expired or revoked key, or one used from an address outside its IP allow-list, gets the same 401 invalid_key.
  • More than 30 failed authentications in a minute from one IP address get 429 for a minute.
  • The API is for servers. It sends no CORS headers, so browsers cannot call it directly — which also keeps your key out of web pages.

Check your key

GET /me returns the organisation, the team member the key acts as, its scopes and its limits.

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

Keys act as a team member

  • Each key acts as one team member you choose when you create it (by default, the admin creating it).
  • It sees and changes only what that member can in the CRM: their data scope (their own leads, their team’s, or all) and the rights of their role. A scope on the key never adds a right the member does not have.
  • Records the key creates or changes are created or changed by that member; the lead’s activity shows the key’s name with “(API)”.
  • List endpoints also need the member’s export right in the CRM (admins always have it).
  • If the member is blocked or leaves the organisation, the key stops working (403 acts_as_inactive) — create a new one.
  • A key also stops working (401 invalid_key) when the admin who created it is no longer an active admin. A current admin can rotate it to take it over, or revoke it.
  • The platform can lock an organisation’s API & Webhooks (for example after a security problem). While it is locked, admins cannot create keys or webhooks, rotate keys or turn webhooks back on.

API writes behave like edits in the CRM. Automations run and the assignee is notified, just as when someone saves the lead. Zapier and Microsoft Teams relays are not triggered by API writes — use webhooks if another system needs to hear about them. During a free trial the API is read-only.

Requests and responses

Base URLhttps://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1
  • JSON with snake_case field names. Times are ISO-8601 in UTC (2026-11-02T06:45:12.000Z); a date or time you send without a zone is read as India time.
  • Bodies are Content-Type: application/json, at most 256 KB. A field the endpoint does not take is refused (422 unknown_field), and so is an unknown query parameter (400 unknown_parameter) — typos never pass silently.
  • One record comes back as {"data": {…}}; a list as {"data": […], "next_cursor": "…"}.
  • Every answer carries X-Request-Id (quote it when you contact support) and RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset. Retry-After (seconds) comes with 429 and 503.
A list (shortened)
{
  "data": [
    {
      "id": "Hc4Tn8wQ2zLp6Rv1Ks9J",
      "object": "lead",
      "name": "Asha Verma",
      "mobile": "9876543210",
      "…": "…"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJwIjp7…"
}
An error
{
  "error": {
    "code": "invalid_mobile",
    "message": "mobile must be an Indian mobile number (10 digits, optionally with +91 / 0).",
    "field": "mobile",
    "request_id": "req_5d1c0f7a9b2e4c6d8a0b1c2d"
  }
}

Indian mobile numbers

Send mobile in any common Indian form. It is stored as the 10 digits, the same way the CRM’s own import stores it, so duplicates are found whichever form was used.

Accepted mobile formats
You sendStored as
98765432109876543210
+91 98765 432109876543210
0 98765 432109876543210
91-98765-432109876543210
  • Anything that does not come to 10 digits is refused with 422 invalid_mobile.
  • For a number outside India, leave mobile out and send phone_international with + and the country code (for example +44 7911 123456).
  • A new lead needs a name and at least one of mobile, phone_international or email.
  • GET /leads?mobile=… accepts the same forms and returns every lead with that number.

Duplicates

When you create a lead, Grocito first looks for a lead with the same mobile, then one with the same email. on_duplicate decides what happens:

on_duplicate values
on_duplicateWhat happens
errorDefault. 409 duplicate_lead, with existing_lead_id when the key may see that lead.
returnNothing is created; 200 with the existing lead.
mergeOnly the existing lead’s empty fields are filled — nothing is overwritten; 200 with the lead.

Pagination

  • Lists take limit from 1 to 100 (default 25). Leads come newest first (sort=updated_at for the most recently changed).
  • When there is more, the answer has a next_cursor. Send it back as cursor with the same filters for the next page; null means the end. Cursors are opaque and signed — they only work for the same key, list and filters.
  • A page can hold fewer items than limit while next_cursor is still set. Keep going until next_cursor is null.
  • The mobile and email filters return every match at once, without a cursor.

Idempotency

Network errors happen. Send an Idempotency-Key header (any unique text up to 255 characters, such as a UUID) with a POST, and you can safely send it again:

  • The same key with the same body within 24 hours gets the first answer again, with Idempotent-Replayed: true. Nothing is created twice.
  • The same key with a different body gets 422 idempotency_mismatch.
  • While the first request is still running, a repeat gets 409 idempotency_in_progress — retry a moment later.

Limits

Request limits
LimitStandard value
Requests per key120 a minute
Requests per organisation300 a minute
Calls per organisation per dayBy plan — see Who can use it. The day resets at midnight India time.
Failed authentications per IP address30 a minute
Request body256 KB

Over a limit you get 429 (rate_limited or daily_quota_exceeded) with Retry-After in seconds. Read RateLimit-Remaining to slow down before you reach it.

Errors

Errors use the HTTP status and a JSON body: {"error": {"code", "message", "field", "request_id"}}. field is there when one field is at fault. Branch on code; show message to people.

HTTP statuses
StatusMeaning
400Bad request (invalid JSON / parameter / cursor, key in the URL).
401Invalid or missing API key (one message for every reason — unknown, wrong, revoked, expired, IP not allowed, or its creator is no longer an active admin).
403Scope missing, member lacks the right, read-only trial, plugin off, organisation inactive, acts-as member inactive.
404Not found — or not visible to this key (other organisation / outside the member's data scope).
409Duplicate lead / Idempotency-Key still in progress.
413Body over 256 KB / lead too large.
415Body is not application/json.
422Validation error (unknown_field, invalid_mobile …).
429Rate limit / daily quota / too many failed authentications. See Retry-After.
503API switched off or temporarily unavailable. See Retry-After.

Error codes

Error codes
StatusCodeWhat it means
400invalid_jsonThe body is not a valid JSON object.
400invalid_parameterA query parameter has a wrong value (see field).
400unknown_parameterA query parameter this endpoint does not take.
400invalid_cursorThe cursor is not one this API gave out, or belongs to another list or key.
400invalid_idempotency_keyThe Idempotency-Key header is empty or too long (255 characters at most).
400key_in_queryA key was sent in the URL. The request is refused — revoke that key and create a new one, since URLs end up in logs.
401invalid_keyThe key is missing, wrong, expired, revoked or not allowed from this IP address, or the admin who created it is no longer an active admin (one message for every reason).
402wallet_emptyOnly if per-call pricing is ever switched on (it is free today): the organisation’s wallet is empty.
403insufficient_scopeThe key does not have the scope this endpoint needs — or the member it acts as does not have that right in the CRM.
403not_allowedOnly a reminder’s creator, its assignee or an admin key can complete it.
403export_not_allowedLists need the member’s export right in the CRM (admins always have it).
403read_onlyThe organisation is on a trial — the API is read-only.
403plugin_disabledAPI & Webhooks, or the plugin an endpoint needs (Quotation Manager, E-commerce), is not on the plan.
403organisation_inactiveThe organisation’s subscription is not active.
403acts_as_inactiveThe member the key acts as is blocked or removed. Create a new key.
403lead_limit_reachedThe plan’s lead limit is reached.
404not_foundNo such record — or the key may not see it (another organisation, or outside the member’s data scope).
405method_not_allowedThe path exists but not with this method.
409duplicate_leadA lead with this mobile (or email) exists. existing_lead_id is included when the key can see it.
409idempotency_in_progressA request with the same Idempotency-Key is still running. Retry shortly.
413payload_too_largeThe body is over 256 KB.
413lead_too_largeThe lead would grow past the size a record can hold.
415unsupported_media_typeSend the body with Content-Type: application/json.
422unknown_fieldThe body has a field this endpoint does not take (field names it).
422missing_fieldA required field is missing.
422invalid_mobileThe mobile is not a valid Indian mobile. Use phone_international for other countries.
422invalid_phonephone_international needs + and the country code, 8 to 15 digits.
422invalid_email / invalid_date / invalid_number / invalid_valueA field has a value of the wrong form, or one not in your CRM settings (GET /config).
422invalid_assigneeassigned_to is not an active member of the organisation.
422unknown_custom_field / invalid_custom_field / missing_custom_fieldA custom field id or label is unknown, its value is wrong, or a required one is missing.
422idempotency_mismatchThe Idempotency-Key was used before with a different body.
422has_sub_dealsA deal with sub-deals takes its value from them — change the sub-deals instead.
429rate_limitedToo many requests this minute (per key or per organisation). Wait for Retry-After.
429daily_quota_exceededThe organisation used today’s calls (the day resets at midnight India time).
429too_many_auth_failuresMore than 30 failed authentications in a minute from one IP address.
500internal_errorSomething went wrong on our side. Retry; quote the request_id if it keeps happening.
503api_disabled / unavailableThe API is switched off or briefly unavailable. Wait for Retry-After.

Scopes

A key only reaches what its scopes allow — and only what its team member may do in the CRM.

Scopes
ScopeAllowsNeeds
leads:readRead leads—
leads:writeCreate, update and archive leadsNot on a trial
notes:writeAdd notes to leadsNot on a trial
deals:readRead deals—
deals:writeCreate and update dealsNot on a trial
reminders:readRead reminders—
reminders:writeAdd and complete remindersNot on a trial
calls:readRead call logs—
users:readRead team members—
config:readRead statuses, sources, custom fields, deal stages—
quotes:readRead quotationsQuotation Manager plugin
invoices:readRead invoicesQuotation Manager plugin
orders:readRead store ordersE-commerce (online store) plugin
customers:readRead store customersE-commerce (online store) plugin

Endpoints

All paths are relative to the base URL https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1. Replace YOUR_API_KEY and the …_ID placeholders in the samples.

Your key

Check a key: its organisation, the team member it acts as, its scopes and limits.

GET/me

The key, its organisation, the member it acts as, its scopes and limits

Scope: any key

Returns
  • 200data = Me

Errors: 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

Leads

List, read, create, update, archive and restore leads.

GET/leads

List leads (newest first)

Scope: leads:readpaged — cursor

Query
limitinteger
1–100 (default 25).
cursorstring
next_cursor of the previous page.
sortstring
created_at (default) or updated_at. One of: created_at, updated_at
statusstring
Exact status.
sourcestring
Exact source.
assigned_tostring
User id.
mobilestring
Any format; returns every lead with that number (no cursor).
emailstring
Exact email (no cursor).
archivedboolean
true = archived leads only; default false.
created_afterstring
ISO-8601.
updated_afterstring
ISO-8601.
Returns
  • 200A page of leads: data = array of Lead, plus next_cursor

Errors: 400 · 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads?limit=20 \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/leads

Create a lead

Scope: leads:write

Headers
Idempotency-Keystring
Repeat a POST safely: the same key + same body within 24 h returns the first answer (Idempotent-Replayed: true). More
Body application/json
namestringrequired
Required. Up to 200 characters.
mobilestring
Indian mobile in any common form: 9876543210, +91 98765 43210, 098765 43210. Stored as 10 digits.
phone_internationalstring
A non-Indian number with its country code (e.g. +44 7911 123456). Use instead of mobile.
emailstring
—
statusstring
One of GET /v1/config statuses (case-insensitive). Default: the first status.
sourcestring
One of GET /v1/config sources. Default: API.
prioritystring
One of GET /v1/config priorities. Default: Medium.
assigned_tostring
User id of an active member. Default: the key's round robin, else unassigned.
remarkstring
Up to 5000 characters.
companystring
—
received_atstring
ISO-8601 date or date-time (India time when no zone).
custom_fieldsobject
By custom field id or label.
on_duplicatestring
What to do when a lead with the same mobile (or email) exists: error (409, default), return (200 with the existing lead), merge (fill its empty fields). One of: error, return, merge
Returns
  • 200on_duplicate=return / merge: the existing lead: data = Lead
  • 201data = Lead

Errors: 400 · 401 · 403 · 409 · 413 · 415 · 422 · 429 · 503

curl -X POST https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 7f9c2a4e-5b1d-4c3e-9a8f-2d6b0e1c4f7a" \
  -d '{"name":"Asha Verma","mobile":"+91 98765 43210","email":"asha@example.com","source":"Website","remark":"Asked for a demo"}'

GET/leads/{id}

Get a lead

Scope: leads:read

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

PATCH/leads/{id}

Update a lead (only the fields sent)

Scope: leads:write

Path
idstringrequired
Record id.
Body application/json
namestring
—
mobilestring
—
phone_internationalstring
—
emailstring
—
statusstring
—
sourcestring
—
prioritystring
—
assigned_tostringcan be null
null = unassign
remarkstring
—
companystring
—
received_atstring
—
custom_fieldsobject
—
Returns

Errors: 400 · 401 · 403 · 404 · 413 · 415 · 422 · 429 · 503

curl -X PATCH https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"priority":"High","remark":"Wants pricing for 25 users; call back on Monday"}'

POST/leads/{id}/archive

Archive a lead

Scope: leads:write

Path
idstringrequired
Record id.
Body (optional) application/json
reasonstring
—
Returns

Errors: 401 · 403 · 404 · 429

curl -X POST https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/archive \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Not interested right now"}'

POST/leads/{id}/unarchive

Restore an archived lead

Scope: leads:write

Path
idstringrequired
Record id.
Body (optional) application/json
reasonstring
—
Returns

Errors: 401 · 403 · 404 · 429

curl -X POST https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/unarchive \
  -H "Authorization: Bearer YOUR_API_KEY"

Notes

The notes on a lead (shown in the lead’s activity in the CRM).

GET/leads/{id}/notes

List a lead's notes (newest first)

Scope: leads:read

Path
idstringrequired
Record id.
Query
limitinteger
1–100 (default 50).
Returns
  • 200data = array of Note

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/notes \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/leads/{id}/notes

Add a note to a lead

Scope: notes:write

Path
idstringrequired
Record id.
Headers
Idempotency-Keystring
Repeat a POST safely: the same key + same body within 24 h returns the first answer (Idempotent-Replayed: true). More
Body application/json
textstringrequired
Up to 5000 characters.
Returns

Errors: 400 · 401 · 403 · 404 · 413 · 422 · 429

curl -X POST https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/notes \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Spoke on the phone — wants a demo on Friday at 4 pm."}'

Deals

Deals sit on a lead. Stage keys come from GET /config.

GET/leads/{id}/deals

List a lead's deals

Scope: deals:read

Path
idstringrequired
Record id.
Returns
  • 200data = array of Deal

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/deals \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/leads/{id}/deals

Add a deal to a lead (becomes its primary deal)

Scope: deals:write

Path
idstringrequired
Record id.
Headers
Idempotency-Keystring
Repeat a POST safely: the same key + same body within 24 h returns the first answer (Idempotent-Replayed: true). More
Body application/json
titlestringrequired
—
valuenumber
—
stagestring
Stage key; default the first stage.
expected_close_datestring
YYYY-MM-DD
prioritystring
One of: low, medium, high, urgent, critical
assigned_tostring
—
next_stepstring
—
loss_reasonstring
—
Returns

Errors: 400 · 401 · 403 · 404 · 413 · 422 · 429

curl -X POST https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/deals \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Annual plan — 25 users","value":45000,"expected_close_date":"2026-12-15"}'

GET/leads/{id}/deals/{dealId}

Get a deal

Scope: deals:read

Path
idstringrequired
Record id.
dealIdstringrequired
Deal id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/deals/DEAL_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

PATCH/leads/{id}/deals/{dealId}

Update a deal (stage / value / title / close date …)

Scope: deals:write

Path
idstringrequired
Record id.
dealIdstringrequired
Deal id.
Body application/json
titlestring
—
valuenumber
Refused (422 has_sub_deals) for a deal with sub-deals.
stagestring
—
expected_close_datestring
—
prioritystring
—
assigned_tostringcan be null
—
next_stepstring
—
loss_reasonstring
—
Returns

Errors: 400 · 401 · 403 · 404 · 422 · 429

curl -X PATCH https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/deals/DEAL_ID \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":52000,"next_step":"Send the revised quotation"}'

Reminders

Follow-up reminders on leads.

POST/leads/{id}/reminders

Add a reminder to a lead

Scope: reminders:write

Path
idstringrequired
Record id.
Headers
Idempotency-Keystring
Repeat a POST safely: the same key + same body within 24 h returns the first answer (Idempotent-Replayed: true). More
Body application/json
date_timestringrequired
ISO-8601 date-time (India time when no zone).
remarkstring
Up to 1000 characters.
user_idstring
Who is reminded; default the acts-as member. Other members only with an admin key.
Returns

Errors: 400 · 401 · 403 · 404 · 422 · 429

curl -X POST https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/leads/LEAD_ID/reminders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date_time":"2026-11-10T11:00:00+05:30","remark":"Call back about the quotation"}'

GET/reminders

List reminders (by due time, latest first)

Scope: reminders:readpaged — cursor

Query
limitinteger
1–100 (default 25).
cursorstring
next_cursor of the previous page.
lead_idstring
Only this lead's reminders (no cursor).
statusstring
pending / completed / declined.
user_idstring
Who is reminded.
Returns
  • 200data = array of Reminder, plus next_cursor

Errors: 400 · 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/reminders?limit=20 \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/reminders/{id}

Get a reminder

Scope: reminders:read

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/reminders/REMINDER_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/reminders/{id}/complete

Mark a reminder done (its creator, its assignee or an admin key)

Scope: reminders:write

Path
idstringrequired
Record id.
Headers
Idempotency-Keystring
Repeat a POST safely: the same key + same body within 24 h returns the first answer (Idempotent-Replayed: true). More
Returns

Errors: 401 · 403 · 404 · 429

curl -X POST https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/reminders/REMINDER_ID/complete \
  -H "Authorization: Bearer YOUR_API_KEY"

Calls

Call logs (read only).

GET/calls

List call logs (newest first)

Scope: calls:readpaged — cursor

Query
limitinteger
1–100 (default 25).
cursorstring
next_cursor of the previous page.
lead_idstring
Only this lead's calls (no cursor).
user_idstring
Agent.
Returns
  • 200data = array of Call, plus next_cursor

Errors: 400 · 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/calls?limit=20 \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/calls/{id}

Get a call log

Scope: calls:read

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/calls/CALL_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Team members

Your organisation’s members (read only) — use their ids for assigned_to.

GET/users

List team members

Scope: users:read

Returns
  • 200data = array of User

Errors: 401 · 403 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/users \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/users/{id}

Get a team member

Scope: users:read

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/users/USER_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

CRM settings

Statuses, sources, priorities, custom fields and deal stages, as set up in your CRM.

GET/config

Statuses, sources, priorities, custom fields, deal stages

Scope: config:read

Returns

Errors: 401 · 403 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/config \
  -H "Authorization: Bearer YOUR_API_KEY"

Quotations

Read only. Needs the Quotation Manager plugin on your plan.

GET/quotations

List quotations (Quotation Manager plugin)

Scope: quotes:readneeds Quotation Managerpaged — cursor

Query
limitinteger
1–100 (default 25).
cursorstring
next_cursor of the previous page.
lead_idstring
Only this lead's (no cursor).
statusstring
draft / sent / accepted / rejected / invoiced.
Returns
  • 200data = array of Quotation, plus next_cursor

Errors: 400 · 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/quotations?limit=20 \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/quotations/{id}

Get a quotation

Scope: quotes:readneeds Quotation Manager

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/quotations/QUOTATION_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Invoices

Read only. Needs the Quotation Manager plugin on your plan.

GET/invoices

List invoices (Quotation Manager plugin)

Scope: invoices:readneeds Quotation Managerpaged — cursor

Query
limitinteger
1–100 (default 25).
cursorstring
next_cursor of the previous page.
lead_idstring
Only this lead's (no cursor).
statusstring
created / sent / partial / paid.
Returns
  • 200data = array of Invoice, plus next_cursor

Errors: 400 · 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/invoices?limit=20 \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/invoices/{id}

Get an invoice

Scope: invoices:readneeds Quotation Manager

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/invoices/INVOICE_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Store orders

Read only. Needs the E-commerce (online store) plugin on your plan.

GET/orders

List online store orders (E-commerce plugin)

Scope: orders:readneeds E-commerce (online store)paged — cursor

Query
limitinteger
1–100 (default 25).
cursorstring
next_cursor of the previous page.
lead_idstring
Linked lead.
statusstring
Order status.
customer_idstring
Store customer.
Returns
  • 200data = array of Order, plus next_cursor

Errors: 400 · 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/orders?limit=20 \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/orders/{id}

Get a store order

Scope: orders:readneeds E-commerce (online store)

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/orders/ORDER_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Store customers

Read only. Needs the E-commerce (online store) plugin on your plan.

GET/customers

List online store customers (E-commerce plugin)

Scope: customers:readneeds E-commerce (online store)paged — cursor

Query
limitinteger
1–100 (default 25).
cursorstring
next_cursor of the previous page.
lead_idstring
Linked lead.
Returns
  • 200data = array of Customer, plus next_cursor

Errors: 400 · 401 · 403 · 429 · 503

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/customers?limit=20 \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/customers/{id}

Get a store customer

Scope: customers:readneeds E-commerce (online store)

Path
idstringrequired
Record id.
Returns

Errors: 401 · 403 · 404 · 429

curl https://asia-south2-sales-crm-grc.cloudfunctions.net/publicApi/v1/customers/CUSTOMER_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Objects

What the API sends back. Webhooks carry the same objects.

Me

objectstring
—
organizationobject
—
organization.idstring
—
organization.namestring
—
keyobject
—
key.idstring
—
key.prefixstring
—
key.namestring
—
key.scopesarray of string
—
key.expires_atstring (date-time)can be null
—
acts_asobject
—
acts_as.idstring
—
acts_as.namestring
—
acts_as.rolestring
—
acts_as.data_scopestring
One of: all, team, own
read_onlyboolean
—
limitsobject
—
limits.per_key_per_minuteinteger
—
limits.per_org_per_minuteinteger
—
limits.per_org_per_dayinteger
—

Lead

idstring
—
objectstring
One of: lead
namestring
—
mobilestringcan be null
Indian mobile, 10 digits.
phonestringcan be null
Same as mobile, or an international number with + and country code.
emailstringcan be null
—
statusstringcan be null
—
sourcestringcan be null
—
prioritystringcan be null
—
assigned_tostringcan be null
User id of the owner; null = unassigned.
remarkstringcan be null
—
companystringcan be null
—
archivedboolean
—
archived_atstring (date-time)can be null
—
archived_reasonstringcan be null
—
decline_reasonstringcan be null
—
custom_fieldsobject
Custom field values by field id (see GET /v1/config).
deal_valuenumbercan be null
Value of the primary deal.
primary_deal_idstringcan be null
—
deals_countinteger
—
received_atstring (date-time)can be null
—
created_atstring (date-time)can be null
—
updated_atstring (date-time)can be null
—
created_bystringcan be null
User id (or integration name) that created the lead.
updated_bystringcan be null
—

Note

idstring
—
objectstring
One of: note
lead_idstring
—
textstring
—
authorstringcan be null
—
created_atstring (date-time)can be null
—
viastringcan be null
—

Deal

idstring
—
objectstring
One of: deal
lead_idstring
—
titlestring
—
valuenumber
—
stagestringcan be null
Stage key (GET /v1/config deal_stages).
probabilitynumbercan be null
—
typestringcan be null
—
billing_frequencystringcan be null
—
prioritystringcan be null
—
assigned_tostringcan be null
—
expected_close_datestringcan be null
YYYY-MM-DD
next_stepstringcan be null
—
loss_reasonstringcan be null
—
closed_atstring (date-time)can be null
—
sub_deals_countinteger
—
created_atstring (date-time)can be null
—
updated_atstring (date-time)can be null
—

Reminder

idstring
—
objectstring
One of: reminder
lead_idstringcan be null
—
lead_namestringcan be null
—
user_idstringcan be null
—
date_timestring (date-time)can be null
—
remarkstringcan be null
—
statusstring
—
created_bystringcan be null
—
created_atstring (date-time)can be null
—

Call

idstring
—
objectstring
One of: call
lead_idstringcan be null
—
user_idstringcan be null
—
typestringcan be null
—
statusstringcan be null
—
duration_secondsnumbercan be null
—
fromstringcan be null
—
tostringcan be null
—
customer_numberstringcan be null
—
namestringcan be null
—
notesstringcan be null
—
sourcestringcan be null
—
date_timestring (date-time)can be null
—
created_atstring (date-time)can be null
—

User

idstring
—
objectstring
One of: user
namestring
—
emailstringcan be null
—
rolestring
One of: admin, member
statusstring
One of: active, blocked, pending
designationstringcan be null
—

Config

objectstring
—
statusesarray of string
—
sourcesarray of string
—
prioritiesarray of string
—
custom_fieldsarray of CustomField
—
deal_stagesarray of object
—
deal_stages[].keystring
—
deal_stages[].labelstring
—
deal_stages[].probabilitynumbercan be null
—
deal_custom_fieldsarray of CustomField
—

CustomField

idstring
—
labelstring
—
typestring
—
requiredboolean
—
optionsarray of string
—

Quotation

idstring
—
objectstring
One of: quotation
numberstringcan be null
—
versionnumbercan be null
—
lead_idstringcan be null
—
statusstringcan be null
—
typestringcan be null
—
subjectstringcan be null
—
customerDocCustomer
—
currencystring
—
itemsarray of LineItem
—
discount_amountnumbercan be null
—
tax_amountnumbercan be null
—
totalnumbercan be null
—
valid_untilstring (date-time)can be null
—
created_atstring (date-time)can be null
—
updated_atstring (date-time)can be null
—

Invoice

idstring
—
objectstring
One of: invoice
numberstringcan be null
—
lead_idstringcan be null
—
quotation_idstringcan be null
—
quotation_numberstringcan be null
—
order_numberstringcan be null
—
statusstringcan be null
—
customerDocCustomer
—
currencystring
—
itemsarray of LineItem
—
discount_amountnumbercan be null
—
tax_amountnumbercan be null
—
totalnumbercan be null
—
paid_amountnumbercan be null
—
balance_duenumbercan be null
—
due_datestring (date-time)can be null
—
created_atstring (date-time)can be null
—
updated_atstring (date-time)can be null
—

LineItem

namestringcan be null
—
descriptionstringcan be null
—
skustringcan be null
—
hsn_sacstringcan be null
—
quantitynumbercan be null
—
ratenumbercan be null
—
tax_ratenumbercan be null
—
totalnumbercan be null
—

DocCustomer

namestringcan be null
—
emailstringcan be null
—
phonestringcan be null
—
addressstringcan be null
—
gstinstringcan be null
—

Order

idstring
—
objectstring
One of: order
numberstringcan be null
—
sourcestringcan be null
—
statusstringcan be null
—
payment_statusstringcan be null
—
payment_methodstringcan be null
—
customer_idstringcan be null
—
lead_idstringcan be null
—
customerobject
—
customer.namestringcan be null
—
customer.emailstringcan be null
—
customer.phonestringcan be null
—
itemsarray of object
—
items[].product_idstringcan be null
—
items[].namestringcan be null
—
items[].skustringcan be null
—
items[].variantstringcan be null
—
items[].quantitynumbercan be null
—
items[].pricenumbercan be null
—
items[].totalnumbercan be null
—
currencystring
—
subtotalnumbercan be null
—
discountnumbercan be null
—
shippingnumbercan be null
—
taxnumbercan be null
—
totalnumbercan be null
—
coupon_codestringcan be null
—
shipping_addressobjectcan be null
—
shipping_address.namestringcan be null
—
shipping_address.phonestringcan be null
—
shipping_address.line1stringcan be null
—
shipping_address.line2stringcan be null
—
shipping_address.citystringcan be null
—
shipping_address.statestringcan be null
—
shipping_address.pincodestringcan be null
—
shipping_address.countrystringcan be null
—
created_atstring (date-time)can be null
—
updated_atstring (date-time)can be null
—

Customer

idstring
—
objectstring
One of: customer
namestringcan be null
—
emailstringcan be null
—
phonestringcan be null
—
statusstring
—
total_ordersnumber
—
total_spentnumber
—
created_atstring (date-time)can be null
—
updated_atstring (date-time)can be null
—

Webhooks

Webhooks send a signed JSON POST to your HTTPS address when leads, notes, deals, reminders, calls or store orders change — 14 events in all. They are set up in the CRM under API & Webhooks → Webhooks.

Read the webhooks guide: events, payloads, signatures and retries

OpenAPI file

The whole API as an OpenAPI 3.0.3 document — import it into Postman or Insomnia, or generate a client with your favourite code generator.

Download openapi/v1.json

Questions or a missing endpoint? Contact us.