Clients
A client is the unit of onboarding on Aleta. Everything the platform knows — legal entities, accounts, depositories, reporting entities, portfolios, users — hangs off a client. A single workspace can manage many clients, and each client is an isolated permission boundary.
Data model
- Name
id- Type
- string
- Description
Stable identifier for the client. Returned as a 24-char hex string for legacy compatibility; treat it as opaque.
- Name
name- Type
- string
- Description
Display name shown in the product. Free-form, change-safe.
- Name
reference_currency- Type
- ISO-4217 code
- Description
The currency every consolidated report aggregates into. Individual accounts can be denominated in any currency — Aleta converts at the end-of-day FX rate for the target date.
- Name
accounting_method- Type
- enum
- Description
FIFO,AVERAGE, orSPECIFIC_ID. Default realised-gain method used when the custodian doesn't enforce one of its own.
- Name
created_at- Type
- timestamp
- Description
When the client record was created.
Relationships
- A client has many legal entities forming its ownership tree.
- A client has many reporting entities which project the ownership tree into consolidated views.
- A client has many users — humans with scoped access through role assignments.
List clients
Returns every client the authenticated credential can reach. Workspace-level tokens see all clients on the workspace; entity-scoped tokens see only their own client.
Request
curl https://api.aleta.io/v2/clients \
-H "Authorization: Bearer {token}"
Retrieve a client
Fetch a single client by its identifier. Useful when you're holding a reference — for example from a webhook payload — and want the current canonical record.
Request
curl https://api.aleta.io/v2/clients/{id} \
-H "Authorization: Bearer {token}"
Creating, updating, and archiving clients is done from workspace admin — the API intentionally exposes only the read surface for programmatic use. Integrations rarely need to mutate client records themselves.