Create a project

POSThttps://rebaar.in/api/v1/projects/createView as Markdown

Starts a project in Planning. Subject to the plan's project limit (402 `limit_reached`). Optional `pincode`, `stateCode` and `district` are the SITE's: the PIN fills the state and district when they are not sent, a state the PIN rules out is 400 with `field: "pincode"`, and an invoice suggests the site's state as its place of supply.

Headers

Header	Value
Authorizationrequired	`Bearer ck_live_…` — your API key from Settings → API keys
Content-Typerequired	`application/json`

Request body

Field	Type	Description
namerequired	string
typerequired	string	one of "Residential", "Commercial", "Interior", "Renovation"
city	string
address	string
pincode	string	6-digit PIN code. The server fills stateCode and district from it when they are not sent.pattern ^[1-9][0-9]{5}$
district	string	at most 80 characters
stateCode	string	2-digit GST state code, e.g. "29" (Karnataka). 400 with field "pincode" when the PIN is not in that state.pattern ^[0-9]{2}$
value	integer	Estimated project value in PAISE (rupees × 100). ₹1,500.00 = 150000.
clientId	string	A client of your company.
startDate	string (date)	Start date as an ISO YYYY-MM-DD string.
endDate	string (date)	End date as an ISO YYYY-MM-DD string.

Try it

This call changes data. Send runs it in your API sandbox — a practice company with sample data — with a sandbox key, never in your real company. To change real data, run the sample from your own machine with a live key. About the sandbox

Request body (JSON)

curl -X POST 'https://rebaar.in/api/v1/projects/create' \
  -H 'Authorization: Bearer ck_live_xxxxxxxx_…' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Casa Verde",
  "type": "Residential",
  "clientId": "7d3f1c2a-5b8e-4f0a-9c61-2e4b7a9d0c13",
  "value": 875000000,
  "city": "Bengaluru",
  "pincode": "560076",
  "address": "14, 2nd Cross, JP Nagar 7th Phase",
  "startDate": "2026-08-01",
  "endDate": "2027-03-31"
}'

Sandbox key

Only sandbox keys (ck_test_…) — make one in Settings → API keys. It reaches your practice company, never your real data. 30 calls a minute.

Responses

201Created. The new project's id (made from its name).

{
  "id": "casa-verde"
}

400Validation failed. `error` is the first problem found; `field` names it when it is a location, GSTIN, email or delivery-address field.

{
  "error": "Invalid enum value. Expected 'Residential' | 'Commercial' | 'Interior' | 'Renovation', received 'House'"
}

401No `Authorization: Bearer …` header was sent. Or: The key is unknown, revoked or expired — or the company cannot use it.

unauthenticated — No `Authorization: Bearer …` header was sent.

{
  "error": "unauthenticated",
  "message": "Authorization: Bearer <api_key> required"
}

invalid_token — The key is unknown, revoked or expired — or the company cannot use it.

{
  "error": "invalid_token",
  "message": "API key not recognised, revoked, or expired"
}

402Over the plan's project limit; with a sandbox key, the practice company already holds 10,000 projects (`sandbox_limit`); or the plan / subscription does not allow the API.

limit_reached

{
  "error": "limit_reached",
  "message": "Plan Growth is capped at 25 projects.",
  "used": 25,
  "limit": 25
}

sandbox_limit

{
  "error": "sandbox_limit",
  "message": "The sandbox holds at most 10,000 projects. Reset the sandbox in Settings → API keys.",
  "resource": "projects",
  "used": 10000,
  "limit": 10000
}

plan_required

{
  "error": "plan_required",
  "message": "API access requires the Scale plan. This workspace is on Growth.",
  "currentPlan": "growth",
  "requiredPlan": "scale"
}

access_expired

{
  "error": "access_expired",
  "reason": "payment_failed",
  "message": "Workspace does not currently have an active Scale subscription."
}

403The request came from an IP address that is not on the key's allowlist. Or: The key does not carry the scope this method needs: `read` for GET, `write` for POST, PATCH and DELETE.

ip_not_allowed — The request came from an IP address that is not on the key's allowlist.

{
  "error": "ip_not_allowed",
  "message": "Source IP 203.0.113.7 is not on the key's allowlist."
}

insufficient_scope — The key does not carry the scope this method needs: `read` for GET, `write` for POST, PATCH and DELETE.

{
  "error": "insufficient_scope",
  "message": "This API key does not have the 'write' scope.",
  "required": "write",
  "granted": [
    "read"
  ]
}

404`clientId` is not a client of your company.

{
  "error": "client_not_found"
}

429More than 120 requests in a minute with this key (30 with a sandbox key).

rate_limited — More than 120 requests in a minute with this key (30 with a sandbox key).

{
  "error": "Too many requests. Please try again later."
}

500Something failed on our side.

internal — Something failed on our side.

{
  "error": "internal"
}

Errors

Errors every call can return

Status	Code	Meaning	What to do
401	unauthenticated	No `Authorization: Bearer …` header was sent.	Send your API key as `Authorization: Bearer ck_live_…` on every request.
401	invalid_token	The key is unknown, revoked or expired — or the company cannot use it.	Check you copied the whole key. Make a new one in Settings → API keys if it was revoked or has expired.
403	ip_not_allowed	The request came from an IP address that is not on the key's allowlist.	Call from an allowed address, or change the key's IP allowlist in Settings → API keys.
402	plan_required	The company is not on the Scale plan, which includes the API.	The Owner moves the company to Scale in Settings → Billing.
402	access_expired	The subscription is not active (trial over, payment failed, cancelled, paused, locked or closing). `reason` says which.	The Owner pays or renews in Settings → Billing; calls work again at once.
429	—	More than 120 requests in a minute with this key (30 with a sandbox key).	Wait the number of seconds in the `Retry-After` header. Every reply carries `RateLimit-Remaining`, so you can slow down before this happens.
403	insufficient_scope	The key does not carry the scope this method needs: `read` for GET, `write` for POST, PATCH and DELETE.	Make a key with the scope you need in Settings → API keys.
500	internal	Something failed on our side.	Retry with exponential backoff. If it keeps happening, email [email protected] with the time of the call.