Sign in

v1

latestOpenAPI 3.0.32026-07-24411867.5 KB

List clients

Returns clients for the requesting firm. Supports optional exact-match filters.

Notes:

  • By default (show_inactive=false), only paying clients are returned.
  • email, fname, lname, and external_user_id are exact matches.
get/clients

Query parameters

show_inactiveboolean

If true, include inactive (non-paying) clients as well.

emailstring email

Exact email match.

fnamestring

Exact first name match.

lnamestring

Exact last name match.

external_user_idstring

Exact match on the external user ID.

pageinteger

Page number (1-based). Defaults to 1.

per_pageinteger

Number of records per page. Defaults to 50. Maximum 500.

Headers

ngrok-skip-browser-warningstring required
Example:true

Bypass ngrok browser warning (dev only).

Response

Array of clients

idinteger required
emailstring email required
fnamestring required
lnamestring required
full_namestring nullable
time_zonestring nullable
phone_numberstring nullable
preferred_namestring nullable
created_atstring date-time required
activeboolean required

Derived from User#paying

assigned_advisor_idinteger required
work_phone_numberstring nullable
work_phone_extensionstring nullable
work_emailstring email nullable
external_user_idstring nullable
assigned_advisorstring nullable

Assigned advisor full name (string), not an object

All 41 operations