Get entity (with sub-resources)
well_get_entityRead ONE entity with its sub-resources nested in a single call.
Convenience over well_get_schema + well_query_records: resolves the field paths for you and returns the single record with its related data expanded.
depth (relation-nesting BOUNDARY, 1-3, default 1): 1 = the entity + its direct sub-resources (emails, phones, locations, …) 2 = + the sub-resources' related scalars 3 = the full level-3 graph (LARGER payload — use when you need the whole picture) Stops at depth 3. Aggregates are excluded. Each child collection is capped at 50 rows; for a full list or to page a large child collection, use well_query_records on that child root instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The entity's public UUID (the value of its *_id field, e.g. company_id) | |
| root | Yes | Entity type, e.g. companies | people | invoices | transactions | |
| depth | No | Relation-nesting boundary 1-3 (default 1). | |
| workspace_id | No | Target workspace. This read reports one workspace's own data. Omit it and the token's primary workspace answers, which may not be the one you mean; the result names the workspace that did. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | ||
| error | No | ||
| found | Yes | ||
| entity | Yes | ||
| success | Yes | ||
| columnMeta | No | Per-column field meaning ({context, enrichment}) for documented columns — read this to interpret the entity's values. | |
| fields_selected | No | ||
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. |