Skip to main content
GET
Fetch a clinic client user

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

clinic_client_user_id
integer
required

The ID of the clinic client user to retrieve or update

Response

200 - application/json

OK

clinic_client_id
integer
required

The ID of the clinic client this clinic client user belongs to

created
string<date-time>
required

The datetime this object was created.

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

id
integer
required

The ID of the clinic client user

is_deleted
boolean
required

Whether this record is soft deleted or not.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

custom_relationship
string | null

A custom relationship description if relationship_kind is set to 'Other'.

email
string | null

The primary email address of the clinic client user.

first_name
string | null

The first name of the clinic client user.

last_name
string | null

The last name of the clinic client user.

phone_number
integer | null

The primary phone number of the clinic client user.

relationship_kind

The type of relationship this clinic client user has to the clinic client account.

Available options:
SPOUSE,
PARTNER,
PARENT,
CHILD,
SIBLING,
OTHER