Get an entity by ID

client.entities.retrieve(, ?): Entity { id, created_at, display_name, 4 more }

get/entities/{id}

Retrieve detailed information about a specific entity

ParametersExpand Collapse

id: string

ReturnsExpand Collapse

Entity { id, created_at, display_name, 4 more }

id: string

Unique identifier with entity_ prefix

created_at: string

Timestamp when the entity was created

formatdate-time

display_name: string

Display name of the entity

household_id: string

Household ID this entity belongs to

kind: EntityKind

Type of entity - determines the specific subtype and applicable fields

Accepts one of the following:

"REVOCABLE_TRUST"

"IRREVOCABLE_TRUST"

"SLAT_TRUST"

"ILIT_TRUST"

"QPRT_TRUST"

"GRAT_TRUST"

"CRT_TRUST"

"CLT_TRUST"

"INDIVIDUAL_PERSONAL_ACCOUNT"

"JOINT_PERSONAL_ACCOUNT"

"CUSTODIAL_PERSONAL_ACCOUNT"

"INSURANCE_PERSONAL_ACCOUNT"

"QUALIFIED_TUITION_PERSONAL_ACCOUNT"

"RETIREMENT_PERSONAL_ACCOUNT"

"DONOR_ADVISED_FUND"

"PRIVATE_FOUNDATION"

"LLC_BUSINESS_ENTITY"

"LP_BUSINESS_ENTITY"

"GP_BUSINESS_ENTITY"

"SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"

"SCORP_BUSINESS_ENTITY"

"CCORP_BUSINESS_ENTITY"

stage: "PRE_CREATED" | "AI_CREATING" | "AI_CREATION_FAILED" | 7 more

Lifecycle stage of the entity

Accepts one of the following:

"PRE_CREATED"

"AI_CREATING"

"AI_CREATION_FAILED"

"AI_NEEDS_REVIEW"

"DRAFT"

"READY_FOR_PROPOSAL"

"IMPLEMENTATION"

"ACTIVE"

"COMPLETED"

"ARCHIVED"

updated_at: string

Timestamp when the entity was last updated

formatdate-time

Get an entity by ID

import Luminary from 'withluminary';

const client = new Luminary();

const entity = await client.entities.retrieve('id');

console.log(entity.id);

{
  "id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "display_name": "My Revocable Trust",
  "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "kind": "REVOCABLE_TRUST",
  "stage": "PRE_CREATED",
  "updated_at": "2024-01-20T14:45:00Z"
}

Returns Examples

{
  "id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "display_name": "My Revocable Trust",
  "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "kind": "REVOCABLE_TRUST",
  "stage": "PRE_CREATED",
  "updated_at": "2024-01-20T14:45:00Z"
}