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:** `client` and `request` are deprecated aliases for `account` and `opportunity` respectively. They will continue to be returned until all users have migrated. > **AHJ:** The `ahj` key 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 `utility` key 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`), `keyName` is the public > field name used on the record's create/update/read endpoints (e.g. `address`, `isActive`, > `createdAt`) — not the internal storage key. Use the `readOnly` flag 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, `keyName` is the key > used under the `custom` object, and `readOnly` is always `false`.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

record_typeenumOptional
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:** `client` and `request` are deprecated aliases for `account` and `opportunity` respectively. They are still accepted as input.

Response

List of properties
accountlist of objectsOptional
opportunitylist of objectsOptional
projectlist of objectsOptional
vendorlist of objectsOptional
ahjlist of objectsOptional

Customer-defined custom AHJ properties only (isCustom: true). Standard built-in AHJ fields are not included.

clientlist of objectsOptionalDeprecated

Deprecated alias for account. Contains identical data.

requestlist of objectsOptionalDeprecated

Deprecated alias for opportunity. Contains identical data.