Light AIDocs Beta Open Light AI

API reference

GETRetrieve a client

GET /v1/clients/{client_id}: Retrieve a client

GEThttps://api.light-ai.app/v1/clients/{client_id}
Scopeclients:read
CredentialAPI key: Authorization: Bearer lai_live_… (or lai_test_…). Partner keys add Light-AI-Organization.
Test modeWorks 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.

idstringrequired#
Id prefix cli_.
objectstringrequired#
Always client.
livemodebooleanrequired#
false for objects created with a test key.
first_namestring | nullrequired#
last_namestring | nullrequired#
emailstring | nullrequired#
phonestring | nullrequired#
E.164, or null when the stored number could not be normalized (see phone_raw).
phone_rawstring | nullrequired#
The number as stored in Light AI.
primary_propertyobject | nullrequired#
primary_property.idstringrequired#
Id prefix prop_.
primary_property.objectstringrequired#
Always property.
primary_property.client_idstring | nullrequired#
Id prefix cli_.
primary_property.is_primarybooleanrequired#
primary_property.property_typestring | nullrequired#
primary_property.addressobject | nullrequired#
primary_property.address.line1string | nullrequired#
primary_property.address.line2string | nullrequired#
primary_property.address.citystring | nullrequired#
primary_property.address.regionstring | nullrequired#
primary_property.address.postal_codestring | nullrequired#
primary_property.address.countrystring | nullrequired#
primary_property.address.formattedstringrequired#
Always present. Components may be null for addresses entered as one line.
primary_property.address.latnumber | nullrequired#
primary_property.address.lngnumber | nullrequired#
primary_property.created_attimestamprequired#
RFC 3339 timestamp (UTC, milliseconds).
primary_property.updated_attimestamprequired#
RFC 3339 timestamp (UTC, milliseconds).
property_countintegerrequired#
external_refsobject[]required#
external_refs[].systemstringrequired#
external_refs[].namespacestring | nullrequired#
external_refs[].idstringrequired#
external_refs[].ownerstringrequired#
self: written by your integration (editable); others are read-only. One of: self, organization, partner.
external_refs[].read_onlybooleanrequired#
created_attimestamprequired#
RFC 3339 timestamp (UTC, milliseconds).
updated_attimestamprequired#
RFC 3339 timestamp (UTC, milliseconds).
fixtureboolean#
Always true.

Errors#

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