When to use a sub-org
- Onboard your customers. Create one sub-org per customer so each customer’s funds, counterparties, and activity stay separate.
- Separate business units or entities. Give each legal entity, region, or product line its own sub-org.
- Scope access. Manage who can see and act on each sub-org separately, while you keep one view across the whole organization.
How it works
- Create a sub-org with a name that is unique in your organization.
- Pass its
idassubOrgIdwhen you create vaults, contacts, and bank accounts, and when you get quotes or create transactions. - List sub-orgs to find their IDs later.
Only API users with the
ADMIN or OWNER role and organization-wide access can create sub-orgs. Your organization comes from authentication, so you can’t act on another organization’s sub-orgs.Limits
- The API can create and list sub-orgs. It can’t retrieve a single sub-org by ID, update one, or delete one.
- Sub-orgs created through the API are
MANAGED.
Create a Sub-Org
POST
/api/external/sub_orgs/List Sub-Orgs
GET
/api/external/sub_orgs/Data models
SubOrg
MANAGED or INDEPENDENT. Some existing sub-orgs return null. Read-only. Sub-orgs created through the API are MANAGED.CreateSubOrgRequest
One required field:name: string.
SubOrgListResponse
A paginated list:results: SubOrg[], nextCursor: string | null, and hasNext: boolean.