Skip to main content
GET
cURL

Authorizations

X-Api-Key
string
header
required

Path Parameters

organization_uuid
string<uuid>
required
uuid
string<uuid>
required

Response

200 - application/json
uuid
string<uuid>
required
read-only
external_id
string
required

External identifier for the client

Maximum string length: 50
created
string<date-time>
required
read-only
modified
string<date-time>
required
read-only
accounts
object[]
required
read-only
household
object | null
required

Read-only nested serializer for household in client responses.

status
enum<string>
required

Whether the firm manages this client's money yet, or is modeling them as a prospect.

  • client - Client
  • prospect - Prospect
Available options:
client,
prospect
cross_account_optimization
object
required
holdings_risk_annualized_percentage
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,2}(?:\.\d{0,10})?$
holdings_risk_model
object | null
required

The risk model behind holdings_risk_annualized_percentage: the organization's setting.

holdings_standard_deviation
object | null
required

Historical standard deviation of the current holdings, held at today's weights.

metadata
any | null

Store arbitrary metadata about this client in a JSON field, but should not include PII information.

cross_account_optimization_enabled
boolean