Deal Properties | Lev Platform Docs

Integration Summary

When to use

List properties linked to a deal.
Use this page as the source of truth for reads, filters, pagination, and object shape.

Required scopes

Access is inherited from the connected user or JWT session.
Inspect GET /me or the validate-api-key response to confirm the scopes available to the current token.

Headers

Authorization: Bearer <token>
X-Origin-App: <client-name>
Content-Type: application/json when the endpoint accepts a body

Request schema

Use the path and query parameter tables below or /platform/openapi.json for the machine-readable schema surface.

Response schema

Responses use the standard request_id/timestamp/data envelope. This page documents these object schemas: Property Object.

Enums & values

Enum-like values and filter operators are documented inline on the page where available.
When a value set is account- or tier-dependent, validate against live responses before hard-coding assumptions.

Rate limits

See /rate-limits. Page intentionally through list endpoints and apply backoff on 429 responses.

Examples

curl, TypeScript, Python

Starter example: GET /api/external/v2/deals/{deal_id}/properties

bash

curl -X GET "https://api.levcapital.com/api/external/v2/deals/{deal_id}/properties" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Origin-App: my-integration"

Connect your API key to explore

Stored in your browser session only. Never sent to our docs server.

GET/api/external/v2/deals/{deal_id}/properties

Path Parameters

deal_id*

Query Parameters

limit

https://api.levcapital.com/api/external/v2/deals/{deal_id}/properties?limit=10

List Properties

GET/api/external/v2/deals/{deal_id}/properties

List properties associated with a deal

Path parameters

Parameter	Type	Required	Description
`deal_id`	`integer`	Required	The deal ID

Response (200):

json

{
  "request_id": "...",
  "timestamp": "2026-03-20T15:30:45Z",
  "data": [
    {
      "id": 301,
      "name": "123 Main Street",
      "address": "123 Main St",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "asset_type_id": 5,
      "units": 50,
      "square_footage": 45000.0,
      "year_built": 1985
    }
  ]
}

Error responses

401unauthorized

When: Missing or invalid Authorization header

{
  "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "error": {
    "status": 401,
    "type": "unauthorized",
    "message": "Authentication required",
    "details": {}
  }
}

404not_found

When: The deal_id doesn't exist or isn't accessible to the authenticated user

{
  "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "error": {
    "status": 404,
    "type": "not_found",
    "message": "Deal not found",
    "details": {}
  }
}

Property Object

Field	Type	Description
`id`	integer	Property identifier
`name`	string\|null	Property name
`address`	string\|null	Street address
`city`	string\|null	City
`state`	string\|null	State (2-letter code)
`zip`	string\|null	ZIP code
`asset_type_id`	integer\|null	Asset type ID
`units`	integer\|null	Number of units
`square_footage`	number\|null	Total square footage
`year_built`	integer\|null	Year the property was built

Build on Lev's Platform Authentication Quickstart API Keys Pagination