Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Lead Transaction

List Transaction Custom Fields

Returns the team-level custom field definitions applicable to transactions. Use the returned ids when populating LeadTransaction.customFields on create / update.

Scope: the caller's team.

get/v1.0/transaction/customfields

Headers

Authorizationstring required

Bearer [access_token]

Response

List of custom field definitions (may be empty).

idinteger

Custom field id.

namestring

Custom field display name.

type'DATE' | 'TEXT' | 'NUMBER' | 'PERCENTAGE' | 'Single-Select' | 'Multi-Select' | 'CURRENCY' | 'HTML'

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.

paramsstring

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 response

[
  {
    "id": 1001,
    "name": "Closing Agent",
    "type": "Single-Select",
    "params": "[{\"label\":\"Option A\",\"value\":\"1\"},{\"label\":\"Option B\",\"value\":\"2\"}]"
  }
]