GET V2/Workers/Worker

Filter by OrgID

Include records where RecordState == RecordState.Active

Include records where RecordState == RecordState.Inactive

Include records where RecordState == RecordState.Deleted

When searching by string, include records based on match type

Filter by WorkerIDs

Filter by BusinessUnit(s)

Filter by BusinessUnitStatuses

Filter by BusinessUnitStatuses Types

Filter by Group(s)

Filter by GroupStatuses

Filter by GroupStatuses Types

Filter by Area

Filter by JobTitle

Filter by Name

Filter by BirthDateMin

Filter by BirthDateMax

Exclude workers which have been linked to users

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

Include binaries

Filter by Fields

Filter by EntityUserChangeLastUpdatedOnMin

Filter by EntityUserChangeCodes

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

The unique identifier for the Org record.

The unique identifier for the Worker record (maps to EntityID).

The Area of the Worker record. Input from code table entries where TableName is "Areas", ().

The full name of the Worker record,

The full address of the Worker record,

The list of Business units attached to the Worker record,

The list of Groups attached to the Worker record,

The list of Notifications attached to the Worker record,

The list of Communication Methods attached to the Worker record,

The list of Form Data Extensions attached to the Worker record,

The Job Title of the Worker record. Input from code table entries where TableName is "Job Titles", ().

The Marital Status of the Worker record. Input from code table entries where TableName is "Marital Statuses", ().

The Gender of the Worker record. Input from code table entries where TableName is "Genders", ().

The Birth Date of the Worker record.

The Birth Month of the Worker record.

The Birth Day of the Worker record.

Is the Worker Birth Date an Estimated value.

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

The Windows Timezone for the Worker record.

A collection of additional properties for the Worker record.

Comments associated with the Worker record.

The Record state of the Worker record. .

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.

This field is read-only and is automatically set from the summary of the Workers name.

This field is read-only and is derived from the existence of the ImageEntityFileID.

The unique identifier for the Worker records Entity File of type EntityImage

An encrypted representation of the Worker records ImageEntityFileID

This field is derived from the FileDate of the Entity Image file associated with the Worker record. This field is read-only

This field is derived from the LastUpdateDateUtc of the Entity Image file associated with the Worker record. This field is read-only

The value of the PartialData used as the criteria when requesting the Worker record.