SOsoraban
Clients

List clients

Changed on

Returns the firm's clients. Inactive clients are excluded unless show_inactive is true.

get/clients

Request

Query parameters

show_inactiveboolean

Include clients marked inactive.

emailstring

Exact match on email.

fnamestring

Exact match on first name.

lnamestring

Exact match on last name.

external_user_idstring

Exact match on your own identifier for the client.

pageinteger

1-based page number.

per_pageinteger

Results per page.

Response

A page of clients.

idinteger
emailstring nullable
fnamestring nullable
lnamestring nullable
full_namestring nullable
time_zonestring nullable
phone_numberstring nullable
preferred_namestring nullable
created_atstring date-time
last_activity_atstring date-time nullable
preferred_sign_in_methodstring nullable
activeboolean nullable

False for a client marked inactive.

work_phone_numberstring nullable
work_phone_extensionstring nullable
work_emailstring nullable
external_user_idstring nullable
assigned_advisor_idinteger nullable

Only present for firms on the older contact management model.

assigned_advisorstring nullable

Only present for firms on the older contact management model.

Changes

  • 1c230fa547adRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the / response's property type changed from string to string null, and format from email to no format for status

    • breaking

      the / response's property type changed from string to string null, and format from email to no format for status

    • warning

      deleted the header request parameter ngrok-skip-browser-warning

    • info

      api operation id listClients was added

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      api tag Clients added

    • info

      for the query request parameter email, the format was generalized from email to no format

    • info

      removed the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status