Skip to main content
GET
List company attributes available for policy checks

Authorizations

x-api-key
string
header
required

Query Parameters

user_id
integer

Account to inspect. Honoured only for admins.

Response

Ok

check_options
any
read-only

Allowed check forms and any conditional inputs for this value type.

description
string | null
read-only

What the value means, written for the customer reading their own rules - the status words a position count admits, what a window is anchored to, when the value is missing rather than zero. Null for a label with no curated description yet. Present only for accounts on policy versions

display_name
string
read-only

The attribute's human-readable name, with its tier as a qualifier, e.g. "NSF days last 30 days", "Open judgment total amount (12 months, background check, owner 1)". Parameters are not part of the name - render them from parameters where the context wants them. Derived, so it may be reworded. Present only for accounts on policy versions

label
string

The attribute's stable identifier, which a check refers to and a CRM field maps onto. Namespaced with ":" where a source groups its attributes, e.g. "nsf_days_last_30_days", "BackgroundCheck:owner_1:open_total_amount_judgment_12mo"

parameter_definitions
any
read-only

Presentation metadata for every parameter axis, including its name, description, default value and an option-to-label map. Null for an unparametrised label

parameters
object | null

Which variant of a parametrised label this is, e.g. {"product_type": "mca", "status": "active_only"}. Null for a label that takes no parameters, and null on a catalogue listing, where parameter definitions give the choices instead

topic_path
string[]
read-only

The picker hierarchy from broad topic to narrow topic.

type
enum<string>

The value's type, which decides what a check on it can compare: "int", "float", "decimal", "string", "date", "datetime", "bool"

Available options:
float,
int,
decimal,
string,
date,
datetime,
bool
unit
any | null

How to format the value, which type alone cannot say: "currency" (in the deal's currency), "percentage" (already in percent points), "count", "ratio" (a 0-1 quotient), "days", "text". Null for an attribute with no declared unit - print the raw value

Available options:
currency,
percentage,
count,
ratio,
days,
text,
null
value_set
any | null

The finite vocabulary the value is drawn from, so the editor can offer a dropdown instead of free text. Keys into the /policy_value_sets response. Null for free text

Available options:
us_state,
naics_industry,
null