GET Clients/Client

Include records where RecordState == RecordState.Active

Include records where RecordState == RecordState.Inactive

Include records where RecordState == RecordState.Deleted

Exclude records where BU is Discharged/Deceased

Exclude records where BU is Discharged

Exclude records where BU is Deceased

Include extension Resident Number

When searching by string, include records based on match type

Filter by ClientIDs

Filter by Area

Filter by Gender

Filter by MaritalStatus

Filter by JobTitle

Filter by Comments

Filter by BirthDateMin

Filter by BirthDateMax

Filter by DeceasedDateMin

Filter by DeceasedDateMax

Filter by Name

Name to match with first or last name.

Filter by CreatedDateUtcMin

Filter by CreatedDateUtcMax

Filter by Business Unit's CreatedDateUtcMin

Filter by Business Unit's CreatedDateUtcMax

Filter by LastUpdatedDateUtcMin

Filter by LastUpdatedDateUtcMax

Filter by Business Unit's LastUpdatedDateUtcMin

Filter by Business Unit's LastUpdatedDateUtcMax

Filter by BusinessUnit(s)

Filter by BusinessUnitStatuses

Filter by Funder(s)

Filter by BusinessUnitStatuses Types

Filter by Group(s)

Filter by Bed Group(s)

Filter by GroupStatuses

Filter by GroupStatuses Types

Filter by Fields

Only return partial data to speed up call (results cannot be used for add/update)

Include binaries

Include caseload criteria (null means don't filter by caseload criteria)

Filter by EntityUserChangeLastUpdatedOnMin

Filter by EntityUserChangeCodes

Sort Critiera for searches

Limit number of rows

The unique identifier for the Client record.

External ID for the client.

The area where the client resides.

Gender. Input from code table entries where TableName is "Genders", ().

Marital Status. Input from code table entries where TableName is "Marital Statuses", ().

The job title of the client.

Comments (if any).

A collection of additional properties for the User, .

The birth date of the client.

The age of the client. This field is read-only and is calculated from the birth date.

The birth month of the client. This field is read-only and is derived from the birth date.

The birth day of the client. This field is read-only and is derived from the birth date.

The date of death of the client.

The Timezone (TZID) for the Client record. Input from code table entries where TableName is "Timezones (TZID)", ().

The Windows Timezone for the Client record.

The state of the record, .

The country code of the client's birth country.

Indicates if the birth date is estimated.

The religion of the client.

The ethnicity of the client.

The full name of the client, .

The addresses of the client, .

The list of business units associated with the client, ."/>

The list of groups attached to the client, .

The name of the client's current group. This field is read-only and is derived from the client's current group.

The client's current group. This field is read-only and is derived from the client's groups, .

This field is read-only and is automatically set from the client's current group. If there's no current group, the primary address is returned.

The reason for the client's current status.

The name of the client's current status.

The start date of the client's current status in UTC.

Indicates if the client is a resident.

Indicates if an image exists for the client. This field is read-only.

The ID of the image entity file.

The key of the image entity file.

The date of the image entity file in UTC.

The last updated date of the image entity file in UTC.

The list of notifications attached to the client, .

The communication methods of the client, .

The list of extensions attached to the client, .

Indicates if only partial data should be returned to speed up the call.

The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly.

The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly.

The summary of the client's name. This field is read-only.

The list of funders for the client, .

The scores of the client, .

The default payment method for accommodation, .

The default payment method for fees, .