Brokers

Outside brokers you work with. Spaces and links can reference a broker by broker_id.

Methods: GET POST PATCH DELETE plus notes. Base URL https://www.leasync.ai/api/v1.

Endpoints#

List brokers#

GET/brokers

Returns a page of brokers with the compact column set. Combine any of the filters below; every filter is a query parameter.

Query parameters

Query parameters for GET /brokers
Name	Type	Description
`limit`optional	integer	Rows per page, 1 to 200. Default 50.
`cursor`optional	string	The `next_cursor` from the previous page. `offset` is accepted as an alias.
`search`optional	string	Case-insensitive partial match on name, email, or company.

Request

bash

curl "https://www.leasync.ai/api/v1/brokers?limit=50" \
  -H "Authorization: Bearer lsk_live_..."

Response

json

{
  "data": [
    {
      "id": "2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22",
      "name": "Alex Chen",
      "email": "alex@examplecre.com",
      "phone": "+1 212 555 0142",
      "company": "Example CRE",
      "created_at": "2026-07-03T13:11:27.000Z"
    }
  ],
  "next_cursor": "50"
}

Retrieve a broker#

GET/brokers/{id}

Returns one broker with every field, including notes and tags. 404 if the record does not exist or you cannot see it.

Path parameters

Path parameters for GET /brokers/{id}
Name	Type	Description
`id`required	uuid	The broker id.

Request

bash

curl https://www.leasync.ai/api/v1/brokers/2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22 \
  -H "Authorization: Bearer lsk_live_..."

Response

json

{
  "data": {
    "id": "2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22",
    "name": "Alex Chen",
    "email": "alex@examplecre.com",
    "phone": "+1 212 555 0142",
    "company": "Example CRE",
    "created_at": "2026-07-03T13:11:27.000Z",
    "office_address": "500 Fifth Ave, New York, NY",
    "priority": null,
    "last_correspondence_at": "2026-09-15T20:31:00.000Z",
    "follow_up_at": null,
    "tag_ids": [],
    "notes": [],
    "created_by": "a1c2…",
    "allowed_users": [],
    "updated_at": "2026-09-15T20:31:00.000Z"
  }
}

Create a broker#

POST/brokers

Creates a broker from a JSON object of column values and returns the full record with status 201. Requires the write scope.

Request

bash

curl -X POST https://www.leasync.ai/api/v1/brokers \
  -H "Authorization: Bearer lsk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alex Chen",
    "email": "alex@examplecre.com",
    "phone": "+1 212 555 0142",
    "company": "Example CRE"
  }'

Response

json

{
  "data": {
    "id": "2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22",
    "name": "Alex Chen",
    "email": "alex@examplecre.com",
    "phone": "+1 212 555 0142",
    "company": "Example CRE",
    "created_at": "2026-07-03T13:11:27.000Z",
    "office_address": "500 Fifth Ave, New York, NY",
    "priority": null,
    "last_correspondence_at": "2026-09-15T20:31:00.000Z",
    "follow_up_at": null,
    "tag_ids": [],
    "notes": [],
    "created_by": "a1c2…",
    "allowed_users": [],
    "updated_at": "2026-09-15T20:31:00.000Z"
  }
}

Update a broker#

PATCH/brokers/{id}

Send only the fields that change. Returns the full updated record. Requires the write scope.

Path parameters

Path parameters for PATCH /brokers/{id}
Name	Type	Description
`id`required	uuid	The broker id.

Request

bash

curl -X PATCH https://www.leasync.ai/api/v1/brokers/2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22 \
  -H "Authorization: Bearer lsk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+1 212 555 0199"
  }'

Response

json

{
  "data": {
    "id": "2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22",
    "name": "Alex Chen",
    "email": "alex@examplecre.com",
    "phone": "+1 212 555 0199",
    "company": "Example CRE",
    "created_at": "2026-07-03T13:11:27.000Z",
    "office_address": "500 Fifth Ave, New York, NY",
    "priority": null,
    "last_correspondence_at": "2026-09-15T20:31:00.000Z",
    "follow_up_at": null,
    "tag_ids": [],
    "notes": [],
    "created_by": "a1c2…",
    "allowed_users": [],
    "updated_at": "2026-09-15T20:31:00.000Z"
  }
}

Delete a broker#

DELETE/brokers/{id}

Permanently deletes the broker. There is no undo. Requires the write scope.

Path parameters

Path parameters for DELETE /brokers/{id}
Name	Type	Description
`id`required	uuid	The broker id.

Request

bash

curl -X DELETE https://www.leasync.ai/api/v1/brokers/2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22 \
  -H "Authorization: Bearer lsk_live_..."

Response

json

{
  "data": {
    "id": "2c9a4e7b-1f3d-4b8a-9e6c-7a5d3b1f0e22",
    "deleted": true
  }
}