DocMergy: How to get Data from Users
The get_user() function allows you to dynamically retrieve profile and system information for a specific HubSpot user so you can merge their details directly into your documents.
How it Works
Unlike other functions, {{get_user()}} does not use keyword arguments. Instead, it requires only a single parameter: the user's email address or their HubSpot Owner ID.
Syntax Examples:
- By Email:
{{get_user("example@integrationglue.com")}} - By Owner Property:
{{get_user(object.hs_owner_id)}} - By Owner ID:
{{get_user("12345689")}}
Outputting Specific User Properties
To display a specific piece of data (such as a name or phone number), append a period (.) followed by the property's internal name to the end of the function.
Example usage:
If you want to merge the user's first name into your document, format your token like this:
{{get_user("example@integrationglue.com").hs_given_name}}
Output: Example
Available User Properties
You can append any of the following default HubSpot properties to the {{get_user()}} function. (Note: If a user's HubSpot profile does not contain data for a specific field, it will output as blank).
Commonly Used Profile Properties
hs_given_name(First Name)hs_family_name(Last Name)hs_searchable_calculated_name(Full Name)hs_email(Email Address)hs_main_phone(Main Phone Number)hs_additional_phone(Additional Phone)hs_job_title(Job Title)hs_language(Primary Language)hs_timezone_auto_update_enabledhs_standard_time_zone
System & Access Properties
hs_access(e.g., super_admin)hs_assigned_seatshs_assigned_permission_setshs_availability_status(e.g., available, away)hs_user_typehs_is_out_of_officehs_is_in_working_hourshs_working_hourshs_out_of_office_hourshs_managerhs_connected_email_statushs_calendar_connection_statushs_calendar_sync_enabled
ID & System Tracking Properties
hubspot_owner_idhs_internal_user_idhs_object_idhubspot_team_idhs_all_accessible_team_idshs_all_assigned_business_unit_idshs_all_owner_idshs_all_team_idshs_direct_teamshs_owning_teamshs_shared_team_idshs_shared_user_idshs_user_all_accessible_teamshs_user_assigned_primary_teamhs_user_direct_teamshs_user_secondary_teamshs_created_by_user_idhs_updated_by_user_idhs_createdatehs_lastmodifieddatehubspot_owner_assigneddatehs_last_activity_timehs_last_password_changehs_last_property_updated_timehs_invite_accepted_timehs_invite_email_statushs_invite_status
Account State Properties
hs_deactivatedhs_hidden(andhs_is_hidden)hs_is_boths_is_managed_agenths_is_partner_userhs_read_only