Onboarding - Default Field Paths

Default Field Paths

Each field has a path (what you reference) and a label (what the picker shows). Paths are grouped by the object they belong to: the employee, employer, client, or job connected to the placement.



Employee

PathLabel
employee.first_nameFirst Name
employee.middle_nameMiddle Name
employee.has_middle_nameHas Middle Name
employee.last_nameLast Name
employee.emailEmail
employee.phonePhone
employee.date_of_birthDate of Birth
employee.social_security_numberSocial Security Number
employee.addressEmployee Address



Employer

PathLabel
employer.nameEmployer Name
employer.einEmployer EIN
employer.addressEmployer Address
employer.idEmployer ID



Client

PathLabel
client.nameClient Name
client.idClient ID



Job

PathLabel
job.nameJob Name
job.addressJob Address
job.idJob ID



Address Components

An address fact ("employee.address", "employer.address", "job.address") expands into components you can reference individually:

  • .street
  • .secondary
  • .city
  • .state
  • .zip
  • .country

For example, "employee.address.state" references just the employee's state, and "job.address.state" references the state of the job.



Custom Attributes

Anything beyond the above default list is a custom attribute you can define on your account. Once created, a custom attribute is referenceable just like a built-in fact, under its entity's "custom_attributes" namespace:

  • employee.custom_attributes.{name}
  • employer.custom_attributes.{name}
  • client.custom_attributes.{name}
  • job.custom_attributes.{name}

Custom attributes appear in the picker alongside the default facts on your account's own forms. They are not available on global forms, which can only reference the default facts above.

*Note* Placement custom attributes (placement.custom_attributes.*) are not referenceable on form fields or in content variables. They live in the policy and rules layer, where they decide which forms get assigned.

For more information, please see the article titled Onboarding - Policy Rule Operators.

Related Articles