Skip to main content

HelloID

Person schema

For more information, see Persons.

To add custom fields to the person schema, Add a custom person or contract field.

Mappable fields

The following fields are included in the default person schema, and can be mapped in Source mappings.

Name

Description

Example

ExternalId

00248687

Username

Victoria97

Aggregation

VAUER19841114ASHTYNLANDF

Location.ExternalId

Location.Code

Location.Name

Details.Gender

F

Details.HonorificPrefix

Details.HonorificSuffix

Details.BirthDate

1984-12-14T00:00:00+00:00

Details.BirthLocality

Ashtynland

Details.MaritalStatus

Married

Name.Initials

V.

Name.GivenName

Victoria

Name.NickName

Victoria

Name.FamilyName

Auer

Name.FamilyNamePrefix

Name.FamilyNamePartner

Ullrich

Name.FamilyNamePartnerPrefix

Name.Convention (required)

B

Status.Blocked

false

Status.Reason

Contact.Personal.Address.Street

Mathilde Gateway

Contact.Personal.Address.StreetExt

Contact.Personal.Address.HouseNumber

159

Contact.Personal.Address.HouseNumberExt

Contact.Personal.Address.PostalCode

20815-4677

Contact.Personal.Address.Locality

Port Julius

Contact.Personal.Address.Country

Azerbaijan

Contact.Personal.Phone.Mobile

248-316-6136

Contact.Personal.Phone.Fixed

277.429.9223 x47389

Contact.Personal.Email

[email protected]

Contact.Business.Address.Street

Contact.Business.Address.StreetExt

Contact.Business.Address.HouseNumber

Contact.Business.Address.HouseNumberExt

Contact.Business.Address.PostalCode

Contact.Business.Address.Locality

Contact.Business.Address.Country

Contact.Business.Phone.Mobile

Contact.Business.Phone.Fixed

Contact.Business.Email

[email protected]

Excluded

false

Special fields

The following fields are not mappable. Instead, they are read-only fields that you can access in various PowerShell scripts and in Notifications.

Name

Description

Example

Custom.<CustomFieldName>

Contains all custom fields that you've added to the person schema with the Add a custom person or contract field feature.

$person.Custom.building

Contracts.#

References the person's Contracts. Replace # with the number of the specific contract to access. To access the person's Primary contract, use $person.Contracts.0..

$person.Contracts.2.StartDate

PrimaryContract

References the person's Primary contract. Same as $person.Contracts.0..

$person.PrimaryContract.StartDate

PrimaryManager

Automatically calculated by HelloID during snapshots according to the Primary manager setting. References the person object of the person's primary manager.

$person.PrimaryManager.DisplayName