Skip to main content
GET
List Transaction Custom Fields

Headers

Authorization
string
required

Bearer [access_token]

Response

List of custom field definitions (may be empty).

id
integer<int64>

Custom field id.

Example:

1001

name
string

Custom field display name.

Example:

"Closing Agent"

type
enum<string>

Custom field data type. Note the mixed casing: Single-Select and Multi-Select are emitted with hyphens and mixed case, while the other values are the upper-case enum names.

Available options:
DATE,
TEXT,
NUMBER,
PERCENTAGE,
Single-Select,
Multi-Select,
CURRENCY,
HTML
Example:

"Single-Select"

params
string

For Single-Select and Multi-Select types, a JSON string encoding the option list, e.g. "[{"label":"Option A","value":"1"},{"label":"Option B","value":"2"}]". Empty or null for non-select types.

Example:

"[{\"label\":\"Option A\",\"value\":\"1\"},{\"label\":\"Option B\",\"value\":\"2\"}]"