API ReferenceProperties

List Properties

Retrieve list of properties organized by record type. When `record_type` is **omitted**, the response includes all keys: `account`, `opportunity`, `project`, `vendor`, and `ahj` — 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.

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.
Allowed values:

Response

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

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

clientlist of objectsDeprecated

Deprecated alias for account. Contains identical data.

requestlist of objectsDeprecated

Deprecated alias for opportunity. Contains identical data.