Projects
Developments and the kinds of home in them (real estate).
GET/projects
List projects
Needs the permission projects:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
limit | query | integer | at least 1. up to 200. default 50 |
cursor | query | string | up to 512 characters |
q | query | string | up to 100 characters |
status | query | one of upcoming, active, on_hold, completed | |
city | query | string | up to 100 characters |
sort | query | one of name, created | default "name" |
order | query | one of asc, desc | default "asc" |
curl -X GET https://crm.anibrosdesign.com/api/v1/projects \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
POST/projects
Create a project
Needs the permission projects:create.
| Parameter | In | Type | Notes |
|---|---|---|---|
Idempotency-Key | header | string | Any unique string up to 128 characters. Repeating the request with the same key returns the first response. up to 128 characters |
| Body field | Type | Notes |
|---|---|---|
name required | string | at least 1 characters. up to 150 characters |
description | string or null | |
developer | string or null | |
city | string or null | |
locality | string or null | |
address | string or null | |
reraId | string or null | |
possessionDate | string (date) or null | |
amenities | list of string | up to 60 items |
status | one of upcoming, active, on_hold, completed |
curl -X POST https://crm.anibrosdesign.com/api/v1/projects \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","description":"text","developer":"text"}'Responses:
201 400 401 402 403 429
POST/projects/price-changes/{id}/undo
Undo (projects)
Needs the permission properties:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/projects/price-changes/{id}/undo \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
GET/projects/{id}
Get a project
Needs the permission projects:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/projects/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
PATCH/projects/{id}
Change a project
Needs the permission projects:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
name | string | at least 1 characters. up to 150 characters |
description | string or null | |
developer | string or null | |
city | string or null | |
locality | string or null | |
address | string or null | |
reraId | string or null | |
possessionDate | string (date) or null | |
amenities | list of string | up to 60 items |
status | one of upcoming, active, on_hold, completed |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/projects/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","description":"text","developer":"text"}'Responses:
200 400 401 402 403 404 412 429
DELETE/projects/{id}
Delete a project
Needs the permission projects:delete.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X DELETE https://crm.anibrosdesign.com/api/v1/projects/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
204 400 401 402 403 404 429
GET/projects/{id}/files
Get files (projects)
Needs the permission projects:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/projects/{id}/files \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
POST/projects/{id}/files
Files (projects)
Needs the permission projects:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) | |
name | query | string | up to 200 characters |
curl -X POST https://crm.anibrosdesign.com/api/v1/projects/{id}/files \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
201 400 401 402 403 404 429
GET/projects/{id}/overview
Get overview (projects)
Needs the permission projects:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/projects/{id}/overview \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
POST/projects/{id}/price-change
Price change (projects)
Needs the permission properties:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) | |
Idempotency-Key | header | string | Any unique string up to 128 characters. Repeating the request with the same key returns the first response. up to 128 characters |
| Body field | Type | Notes |
|---|---|---|
unitTypeId | string or null | |
facing | string or null | |
tower | string or null | |
scope | one of available, unsold | default "available" |
mode required | one of set, add, percent | |
amount required | number | at least -10000000000000. up to 10000000000000 |
roundTo | integer or null | |
reason | string or null | |
dryRun | boolean | default false |
curl -X POST https://crm.anibrosdesign.com/api/v1/projects/{id}/price-change \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"unitTypeId":"text","facing":"text","tower":"text","mode":"set","amount":-10000000000000}'Responses:
200 400 401 402 403 404 429
GET/projects/{id}/pricing
Get pricing (projects)
Needs the permission projects:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/projects/{id}/pricing \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
POST/projects/{id}/unit-types
Unit types (projects)
Needs the permission projects:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) | |
Idempotency-Key | header | string | Any unique string up to 128 characters. Repeating the request with the same key returns the first response. up to 128 characters |
| Body field | Type | Notes |
|---|---|---|
name required | string | at least 1 characters. up to 120 characters |
propertyType | one of apartment, villa, townhouse, penthouse, office, retail, plot, other | |
bedrooms | integer or null | |
bathrooms | integer or null | |
areaSqft | number or null | |
carpetAreaSqft | number or null | |
basePrice | number | at least 0. up to 10000000000000 |
totalUnits | integer | at least 0. up to 100000 |
description | string or null | |
createUnits | boolean | |
unitPrefix | string | up to 20 characters |
startAt | integer | at least 1. up to 100000 |
curl -X POST https://crm.anibrosdesign.com/api/v1/projects/{id}/unit-types \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","propertyType":"apartment","bedrooms":0}'Responses:
201 400 401 402 403 404 429
Something missing or unclear? Tell us.