Clients

Retrieve a client

get/clients/{id}

Request

Base URL
https://api.soraban.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/soraban/apis/soraban-private-api/docs/clients/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

The client.

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.

No recorded changes to this operation across all 2 revisions of this API.