Clients

Tenants and leads: the people and businesses looking for space. A client is a lead until it signs, then a tenant. Contacts on the record live in the contacts array.

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

Endpoints#

List clients#

GET/clients

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

Query parameters

Query parameters for GET /clients
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 the record title or the first contact name.
`priority`optional	string	One of `High`, `Medium`, `Low`.
`pin`optional	string	One of `regular`, `pinned`, `hidden`.
`use`optional	string	Retail, Office, Restaurant, Industrial, or Residential.
`concept`optional	string	Business concept, partial match (cafe, gym, and so on).
`client_type`optional	string	`lead` or `tenant`.
`exclude_hidden`optional	boolean	true returns only the active pipeline (drops hidden records).

Request

bash

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

Response

json

{
  "data": [
    {
      "id": "4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10",
      "title": "Blue Bottle Coffee",
      "contacts": [
        {
          "name": "Dana Ruiz",
          "email": "dana@bluebottle.com"
        }
      ],
      "priority": "High",
      "concept": "Cafe",
      "use": "Retail",
      "preferred_areas": [
        "SoHo",
        "Nolita"
      ],
      "price_range_min": "15000",
      "price_range_max": "25000",
      "preferred_sqft_min": "1200",
      "preferred_sqft_max": "2000",
      "pin": "regular",
      "follow_up_at": null,
      "last_contacted_at": "2026-09-18T14:02:11.000Z",
      "created_at": "2026-09-01T16:40:03.000Z"
    }
  ],
  "next_cursor": "50"
}

Retrieve a client#

GET/clients/{id}

Returns one client 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 /clients/{id}
Name	Type	Description
`id`required	uuid	The client id.

Request

bash

curl https://www.leasync.ai/api/v1/clients/4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10 \
  -H "Authorization: Bearer lsk_live_..."

Response

json

{
  "data": {
    "id": "4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10",
    "title": "Blue Bottle Coffee",
    "contacts": [
      {
        "name": "Dana Ruiz",
        "email": "dana@bluebottle.com"
      }
    ],
    "priority": "High",
    "concept": "Cafe",
    "use": "Retail",
    "preferred_areas": [
      "SoHo",
      "Nolita"
    ],
    "price_range_min": "15000",
    "price_range_max": "25000",
    "preferred_sqft_min": "1200",
    "preferred_sqft_max": "2000",
    "pin": "regular",
    "follow_up_at": null,
    "last_contacted_at": "2026-09-18T14:02:11.000Z",
    "created_at": "2026-09-01T16:40:03.000Z",
    "client_type": "lead",
    "broker_id": null,
    "tag_ids": [],
    "notes": [],
    "created_by": "a1c2…",
    "allowed_users": [],
    "updated_at": "2026-09-18T14:02:11.000Z"
  }
}

Create a client#

POST/clients

Creates a client 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/clients \
  -H "Authorization: Bearer lsk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Blue Bottle Coffee",
    "client_type": "lead",
    "contacts": [
      {
        "name": "Dana Ruiz",
        "email": "dana@bluebottle.com"
      }
    ],
    "concept": "Cafe",
    "use": "Retail",
    "priority": "High",
    "preferred_areas": [
      "SoHo",
      "Nolita"
    ],
    "price_range_min": "15000",
    "price_range_max": "25000"
  }'

Response

json

{
  "data": {
    "id": "4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10",
    "title": "Blue Bottle Coffee",
    "contacts": [
      {
        "name": "Dana Ruiz",
        "email": "dana@bluebottle.com"
      }
    ],
    "priority": "High",
    "concept": "Cafe",
    "use": "Retail",
    "preferred_areas": [
      "SoHo",
      "Nolita"
    ],
    "price_range_min": "15000",
    "price_range_max": "25000",
    "preferred_sqft_min": "1200",
    "preferred_sqft_max": "2000",
    "pin": "regular",
    "follow_up_at": null,
    "last_contacted_at": "2026-09-18T14:02:11.000Z",
    "created_at": "2026-09-01T16:40:03.000Z",
    "client_type": "lead",
    "broker_id": null,
    "tag_ids": [],
    "notes": [],
    "created_by": "a1c2…",
    "allowed_users": [],
    "updated_at": "2026-09-18T14:02:11.000Z"
  }
}

Update a client#

PATCH/clients/{id}

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

Path parameters

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

Request

bash

curl -X PATCH https://www.leasync.ai/api/v1/clients/4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10 \
  -H "Authorization: Bearer lsk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "priority": "Medium",
    "follow_up_at": "2026-10-02"
  }'

Response

json

{
  "data": {
    "id": "4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10",
    "title": "Blue Bottle Coffee",
    "contacts": [
      {
        "name": "Dana Ruiz",
        "email": "dana@bluebottle.com"
      }
    ],
    "priority": "Medium",
    "concept": "Cafe",
    "use": "Retail",
    "preferred_areas": [
      "SoHo",
      "Nolita"
    ],
    "price_range_min": "15000",
    "price_range_max": "25000",
    "preferred_sqft_min": "1200",
    "preferred_sqft_max": "2000",
    "pin": "regular",
    "follow_up_at": "2026-10-02",
    "last_contacted_at": "2026-09-18T14:02:11.000Z",
    "created_at": "2026-09-01T16:40:03.000Z",
    "client_type": "lead",
    "broker_id": null,
    "tag_ids": [],
    "notes": [],
    "created_by": "a1c2…",
    "allowed_users": [],
    "updated_at": "2026-09-18T14:02:11.000Z"
  }
}

Delete a client#

DELETE/clients/{id}

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

Path parameters

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

Request

bash

curl -X DELETE https://www.leasync.ai/api/v1/clients/4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10 \
  -H "Authorization: Bearer lsk_live_..."

Response

json

{
  "data": {
    "id": "4b0d2f6e-9d3a-4c2b-9a1e-1f4b7a2c8d10",
    "deleted": true
  }
}