List Properties
Retrieve list of properties organized by record type.
When record_type is omitted, the response includes all keys: account, opportunity,
project, vendor, ahj, and utility — plus the deprecated alias keys client and request.
When record_type is provided, the response contains only the requested key(s). Filtering
by account or client returns both account and client (identical data); filtering by
opportunity or request returns both opportunity and request (identical data).
Note:
clientandrequestare deprecated aliases foraccountandopportunityrespectively. They will continue to be returned until all users have migrated.
AHJ: The
ahjkey returns only customer-defined custom properties (isCustom: true). Standard built-in AHJ fields are not included here — they are exposed directly on the AHJ object instead, and are not updatable via the public API.
Utility: The
utilitykey returns only customer-defined custom properties (isCustom: true). Standard built-in utility fields are not included here — they are exposed directly on the utility object instead, and are not updatable via the public API.
keyName semantics: For built-in properties (
isCustom: false),keyNameis the public field name used on the record’s create/update/read endpoints (e.g.address,isActive,createdAt) — not the internal storage key. Use thereadOnlyflag to tell which built-in fields can be sent on create/update (readOnly: false) versus which are system/derived fields you can only read (readOnly: true). For custom properties,keyNameis the key used under thecustomobject, andreadOnlyis alwaysfalse.
Authentication
Query parameters
Filter by record type. Can also be supplied as a comma-separated list
(?record_type=project,vendor) or repeated (?record_type=project&record_type=vendor)
to request multiple types in one call.
When omitted, the response includes every record-type key. When supplied, the response
includes only the requested key(s) — plus the matching deprecated alias key where
applicable (account ↔ client, opportunity ↔ request).
Note:
clientandrequestare deprecated aliases foraccountandopportunityrespectively. They are still accepted as input.
Response
Customer-defined custom AHJ properties only (isCustom: true). Standard built-in AHJ fields are not included.
Deprecated alias for account. Contains identical data.
Deprecated alias for opportunity. Contains identical data.
