Default Selectors

  • Updated

Who needs to be aware of this information? 

Filevine users responsible for managing automations.
For more information about getting field codes and selectors please visit: How to Get Selectors and Field Codes

 

To ensure Neodeluxe Automations function properly, it is recommended that your field selectors match the descriptions below.

This guide provides an overview of:

  • Default field selectors used in Filevine
  • Syntax rules for referencing fields
  • Examples to demonstrate proper usage

Understanding Field Selectors

Each object in Filevine (such as Client, Person, or Project) has selectors that help reference specific data. The basic syntax follows this structure:

object.selector[Optional Subfields]

For example:

  • To reference a client’s first name:
client.firstName
  • If the selector is a list, specify the item position in brackets:
client.phones[1].number
  • If the selector is JSON, they can be followed by more nested subfields:
Project.clientId.[subfields]

Client Object Selectors

Person ID: ItemId (JSON)

  • Syntax: 
Client.personId.[subfield]

Subfields for ItemId*

  • native: integer
  • partner: integer

For example:

Object Selector Type Subfields Example
Client personId ItemId* native Client.personId.native
partner Client.personId.partner

String or Boolean Fields

These fields hold text (string) or true/false (boolean) values.

  • Syntax:
 Client.[selector]

For example:

Object Selector Type Example
Client abbreviatedName String Client.abbreviatedName
barNumber String Client.barNumber
birthDate String Client.birthDate
deathDate String Client.deathDate
department String Client.department
driverLicenseNumber String Client.driverLicenseNumber
fiduciary String Client.fiduciary
firstName String Client.firstName
fullName String Client.fullName
fromCompany String Client.fromCompany
gender String Client.gender
isDeceased Boolean Client.isDeceased
isMinor Boolean Client.isMinor
isSingleName Boolean Client.isSingleName
jobTitle String Client.jobTitle
lastName String Client.lastName
maritalStatus String Client.maritalStatus
middleName String Client.middleName
pictureKey String Client.pictureKey
pictureUrl String Client.pictureUrl
prefix String Client.prefix
primaryEmail String Client.primaryEmail
salutation String Client.salutation
suffix String Client.suffix
uniqueId String Client.uniqueId

List Fields (String Lists)

These fields contain lists of strings, such as person types or hashtags.

  • Syntax:
 Client.[selector][N]

Where [N] indicates the item position in the list. The first item in the list is at position N=1, List[1].

For example:

Object Selector Example
Client personTypes Client.personTypes[1]
searchNames Client.searchNames[3]
hashtags Client.hashtags[4]

List Fields (Phone, Addresses, Emails)

For phone numbers, addresses, or emails: 

  • Syntax:
 Client.[selector][N].[subfield].[Optional Subfields]
Where [N] indicates the item position in the list. The first item in the list is at position N=1, List[1].

PHONE - For example:

Object Selector Subfields Type Example
Client phones[N] phoneId ItemId* Client.phones[3].phoneId.native
Client.phones[1].phoneId.partner
number String Client.phones[1].number
rawNumber String Client.phones[4].rawNumber
label String Client.phones[7].label
links JSON Client.phones[8].links
 

ADDRESS - For example:

Object Selector Subfields Type Example
Client addresses[N] addressId ItemId* Client.addresses[1].addressId.native
Client.addresses[1].addressId.partner
line1 String Client.addresses[4].line1
line2 String Client.addresses[3].line2
city String Client.addresses[1].city
state String Client.addresses[5].state
postalCode String Client.addresses[3].postalCode
fullAddress String Client.addresses[2].fullAddress
label String Client.addresses[1].label
links JSON Client.addresses[8].links

 

 

EMAIL - For example:

Object Selector Subfields Type Example
Client emails[N] emailId ItemId* Client.emails[1].emailId.native
Client.emails[3].emailId.partner
address String Client.emails[2].address
links JSON Client.emails[4].links
label String Client.emails[7].label
 

Links

These fields hold links.

  • Syntax:
Client.[selector]

For example:

Object Selector Subfields Type Example
Client links self String Client.links.self
projects String Client.links.projects
phones String Client.links.phones
emailAddresses String Client.links.emailAddresses
addresses String Client.links.addresses

Person Object Selectors

The person object follows the same syntax as the Client object, but is referenced through specific sections.

For example: The Claimant field in the Case Summary section’s first listed phone number:

casesummary.claimant.phones[1].number

Project Object Selectors

  • Syntax:
 Project.[selector].[Optional Subfields]

For example:

Object Selector Type Example
Project clientId JSON Project.clientId.native
clientName String Project.clientName
clientPictureKey String Project.clientPictureKey
clientPictureURL String Project.clientPictureURL
firstPrimaryName String Project.firstPrimaryName
firstPrimaryUsername String Project.firstPrimaryUsername
incidentDate String Project.incidentDate
isArchived String Project.isArchived
lastActivity String Project.lastActivity
number String Project.number
orgId String Project.orgId
phaseId String Project.phaseId
phaseName String Project.phaseName
projectEmailAddress String Project.projectEmailAddress
projectId JSON Project.projectId
projectName String Project.projectName
projectOrClientName String Project.projectOrClientName
projectTypeCode String Project.projectTypeCode
projectTypeId JSON Project.projectTypeId
projectUrl String Project.projectUrl
rootDocFolderId JSON Project.rootDocFolderId
uniqueKey string Project.uniqueKey

 

Have Questions or Issues?

If you have any questions or you are experiencing issues with accessing or using our Automations, please contact our Product Support Team:

Our Product Support Team is available Monday through Friday, from 8:00 AM - 5:00 PM CST.

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.