API reference

GETList a client's properties

GET /v1/clients/{client_id}/properties: List a client's properties

GEThttps://api.light-ai.app/v1/clients/{client_id}/properties

Scope	`clients:read`
Credential	API key: `Authorization: Bearer lai_live_…` (or `lai_test_…`). Partner keys add `Light-AI-Organization`.
Test mode	Works with test keys against simulated test objects.

Path parameters#

client_idstringrequired#

The client id (cli_…). Id prefix cli_.

Headers#

Light-AI-Organizationstring#

Partner keys: the connected organization to act for (org_…). Organization keys may omit it. Id prefix org_.

Light-AI-Versionstring#

Pin a dated API version (defaults to the key's version). One of: 2026-11-01.

Response 200#

The client's properties, primary first.

objectstringrequired#

Always list.

dataobject[]required#

data[].idstringrequired#

Id prefix prop_.

data[].objectstringrequired#

Always property.

data[].client_idstring | nullrequired#

Id prefix cli_.

data[].is_primarybooleanrequired#

data[].property_typestring | nullrequired#

data[].addressobject | nullrequired#

data[].address.line1string | nullrequired#

data[].address.line2string | nullrequired#

data[].address.citystring | nullrequired#

data[].address.regionstring | nullrequired#

data[].address.postal_codestring | nullrequired#

data[].address.countrystring | nullrequired#

data[].address.formattedstringrequired#

Always present. Components may be null for addresses entered as one line.

data[].address.latnumber | nullrequired#

data[].address.lngnumber | nullrequired#

data[].created_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

data[].updated_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

has_morebooleanrequired#

next_cursorstring | nullrequired#

Pass as cursor to fetch the next page.

Errors#

Status	Meaning
`400`	Bad request. `bad_request`, `test_mode_mismatch`, `test_mode_unsupported`, `unsupported_api_version`
`401`	Missing or invalid credential. `authentication_required`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `api_key_suspended`
`403`	Not allowed. `insufficient_scope`, `plan_upgrade_required`, `organization_paused`, `organization_off_season`, `api_disabled`, `api_access_not_enabled`, `ip_not_allowed`, `forbidden`
`404`	Not found (also for objects of other organizations and for organizations without an active grant).
`422`	Validation failed. `idempotency_key_reused`
`429`	Rate limited or daily cap reached. See Retry-After and the RateLimit headers. `rate_limited`, `daily_cap_reached`
`500`	Unexpected server error. Safe to retry with exponential backoff; quote the Request-Id to support. `internal_error`
`503`	Temporarily unavailable. Retry with exponential backoff. `service_unavailable`

Request

curl -X GET "https://api.light-ai.app/v1/clients/{client_id}/properties" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY"

const response = await fetch('https://api.light-ai.app/v1/clients/{client_id}/properties', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
  },
});
const data = await response.json();

import os, uuid, requests

response = requests.get(
    "https://api.light-ai.app/v1/clients/{client_id}/properties",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
    },
    timeout=30,
)
data = response.json()

Response 200JSON

{
  "object": "list",
  "data": [
    {
      "id": "prop_3f9c2a7be41d…",
      "object": "property",
      "client_id": "cli_3f9c2a7be41d…",
      "is_primary": true,
      "property_type": "string",
      "address": {
        "line1": "4102 Oak Hollow Dr",
        "line2": "string",
        "city": "Austin",
        "region": "TX",
        "postal_code": "78731",
        "country": "US",
        "formatted": "string",
        "lat": 0,
        "lng": 0
      },
      "created_at": "2026-10-12T14:03:11.000Z",
      "updated_at": "2026-10-12T14:03:11.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}