Levels

Every entity is curated at three depths, and the caller picks one per request. Levels size the payload to the question: one deep record for “what’s the status of this deal,” 25 lean rows for “which deals close this quarter.”

The three levels

LevelField capIncludes
list10Identifying fields, plus metrics marked available at list level
standard20Fields and metrics
detailed30Everything: fields, metrics, related lists, references, enrichments

detailed is the default when the caller doesn’t specify. The caps count flat fields on the record only — metrics, related lists, references, and enrichments have their own controls.

Levels are cumulative

Each level includes everything the leaner levels include. Curate outward: pick the fields that identify a record for list, add the ones that describe it for standard, add the rest for detailed.

list sets the columns everywhere

An entity’s list fields are also the columns used when its records appear inside another payload:

  • Rows in a related list on a parent record
  • Rows returned by Find Records
  • Rows in a records-shaped enrichment result

If a related list shows unexpected columns, that’s the child entity’s list curation — not a setting on the parent.

Elements and levels

Every element declares a minimum level — the leanest request it appears in. It renders at that level and every richer one. Metrics and formulas default to list: they’re cheap, and a single number often replaces a list of rows. Enrichments default to detailed: a source runs code, typically a query per record.

TIP

An element below the requested level is skipped silently — no warning, no logged issue. If an expected metric is missing from a payload, check its minimum level first.

Pin a level

An entity can pin a level, overriding what the caller asks for. Use it only when a view makes sense at exactly one depth — most entities should let the caller choose.

Related lists (rows × fields) and references (a whole second record) are configured at, and render only at, detailed. For a summary of child records at a leaner level, use a metric: “12 open cases” instead of twelve rows.

What’s next

  • Elements — the shared library of metrics, formulas, and enrichments.