Users
The Users API manages every aspect of platform user accounts — creating and updating individual accounts, sending and tracking invitations, organising users into groups with shared roles and feature flags, and controlling the customisable forms that capture additional investor data and preference information.
Domain model
- Users — individual platform accounts, plus exports for downstream reporting.
- Invitations — send an invite, resend, mark someone as signatory, mint a login token for impersonation, or invite directly into a shell.
- User groups — collections of users with shared roles and feature flags. Includes role assignment and removal flows.
- User data forms — customisable forms that capture additional information about a user, with per-tenant enablement.
- Investor preference forms — preference and enforcement-type forms gated by classification.
Endpoints
User accounts
Get users
Paginated list of users in your tenant.
Get users by type
Paginated list of users filtered by a specific user type.
Get user with all data
Fetch a single user with their full data graph.
Update user information
Update profile fields for a specified user.
Update current user information
Update the authenticated user's own profile fields.
Export users
Download all user records as an export file.
Export users by type
Download user records filtered by type as an export file.
Invitations
Invite user
Send a platform invitation to a new user.
Invite internal user
Send an invitation to an internal team member.
Invite direct to shell
Invite a user directly into a shell environment.
Resend user invite
Re-send an existing invitation to a user.
Mark user as signatory
Designate a user as a signatory within their group.
Create login token
Mint a login token for impersonation scoped to a group and user.
User groups
Get user groups
List all user groups in the tenant.
Get user group
Fetch a single user group by its identifier.
Get user group by lead user
Find the group associated with a given lead user UUID.
Get user group users
List all members belonging to a user group.
Search user groups
Filter user groups by name or other criteria.
Create user group
Create a new user group.
Update user group
Modify the details of an existing user group.
Update user group role
Change a user's assigned role within a group.
Update group feature flag
Enable or disable a feature flag for a user group.
Delete user from group
Remove a user from a user group.
Delete user group
Permanently remove a user group.
Get available roles
List all roles available for assignment within groups.
User data forms
Get user data form
Fetch a single user data form definition.
Get user data forms
List all user data form definitions.
Create user data form
Define a new user data form.
Delete user data form
Permanently remove a user data form definition.
Get all user data form data
Retrieve all submitted form data across user data forms.
Update user data form state
Enable or disable a user data form.
Get enabled user forms
List all user data forms currently enabled for the tenant.
Get enabled user forms for current user
List user data forms enabled for the authenticated user.
Create user data form implementation for user
Assign a user data form to a specific user by creating an implementation.
Investor preference forms
Get investor preference form
Fetch a single investor preference form definition.
Get investor preference forms
List all investor preference form definitions.
Get enabled investor preference forms
List investor preference forms currently enabled for a user.
Create investor preference form
Define a new investor preference form.
Delete investor preference form
Permanently remove an investor preference form definition.
Update investor preference form classifications
Update the investor classifications gating a preference form.
Update investor preference form editable
Set whether investors can edit their preference form answers.
Update investor preference form enforcement type
Change the enforcement type applied to a preference form.
Update investor preference form state
Enable or disable an investor preference form.
Create investor preference form implementation for user
Assign an investor preference form to a specific user.