Users
Retrieve the available users in HubSpot, including standard properties and any custom user properties defined in the account.
View Specific Information
SELECT
The Users view is dynamic. The driver retrieves the column list directly from HubSpot at runtime, so any custom user properties you have defined in your HubSpot account appear as additional columns.
The column names returned depend on the UseDisplayNames connection property. When UseDisplayNames is True (the default), the driver returns the human-readable display name (for example, Availability Status, Job Title). When UseDisplayNames is False, the driver returns the underlying internal property name.
When selecting users, you can filter by columns marked below as Filterable. For those columns, the supported server-side operators are =, !=, <, <=, >, >=, IN, and IS_NOT.
Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:
SELECT * FROM Users WHERE [Job Title] = 'Developer' AND [Last Active] > '2020-01-01'
SELECT * FROM Users WHERE [First Name] = 'John' OR [First Name] = 'William'
In the following server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter on:
SELECT * FROM Users WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Users WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Users WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Users WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})
Difference Between Users, UserProvisioning, and Owners
The Users view contains details about users within a specific HubSpot account, including properties such as working hours, time zone, phone number, and job title. A user in the Users view represents a user only within the HubSpot account from which the data was requested. This differs from the users in the UserProvisioning view, which refer to users across all accounts, and the users in the Owners view, which refer to users as owners of records.
Columns
| Name | Type | References | Filterable | Description |
| Id [KEY] | Long | True | Unique identifier of the object. | |
| Archived | Bool | False | Indicates whether the object is archived. | |
| CreatedAt | Datetime | False | When the object was created. | |
| UpdatedAt | Datetime | False | When the object was last updated. | |
| Access | String | False | The summarized access levels that this user has. | |
| Additional Phone | String | True | The user's additional phone number. | |
| All teams | String | False | The team IDs, including the team hierarchy, of all default and custom owner properties for this record. | |
| Business units | String | False | The business units this record is assigned to. | |
| All owner IDs | String | False | Values of all default and custom owner properties for this record. | |
| All team IDs | String | False | The team IDs of all default and custom owner properties for this record. | |
| Permission Sets | String | False | The permission sets assigned to this user. | |
| Seat | String | False | The seats assigned to this user. | |
| Availability Status | String | True | Describes if the user is available for assignment. | |
| Away Status Timer | String | True | Describes the user away status timer. | |
| Calendar Status | Bool | True | Indicates whether a personal calendar is connected to enable HubSpot Meetings, calendar sync, and scheduling pages. | |
| Calendar Sync | Bool | True | Indicates whether calendar sync logs new meetings from the user's primary calendar to existing contacts in HubSpot. | |
| Calendar visibility mode | String | False | Controls what calendar event information is shown when others book meetings on this user’s behalf. | |
| Email Status | String | False | Personal email accounts connected to HubSpot to log, track, send, and receive emails. | |
| Created by user ID | Decimal | True | The user who created this record. This value is set automatically by HubSpot. | |
| Created date | Datetime | True | The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified. | |
| CRM Initialized | Bool | True | Indicates whether this user was first initialized via the CRM rather than internal systems. | |
| Deactivated | Bool | True | Indicates whether the user is deactivated and no longer has access to this HubSpot account. | |
| Team(s)Deprecated | String | True | The direct (primary and secondary) teams for this user. | |
| String | True | The user's email address. | ||
| Email Notifications Bounce Status | Bool | True | Indicates whether the user is receiving HubSpot email notifications. | |
| Last Name | String | True | The user's last or family name. | |
| First Name | String | True | The user's first or given name. | |
| HubSpot JITA User | Bool | True | Indicates whether this user is a HubSpot JITA user. JITA users are HubSpot employees with temporary access to the portal for support or security purposes. | |
| Internal User ID | Decimal | True | The user's unique internal ID in HubSpot's centralized database. This is not portal-specific. | |
| Invite Accepted Time | Datetime | True | The time the user accepted their invite to the portal. | |
| InviteEmailStatus | String | False | Displays the status of the user's invite email. | |
| Invite Status | String | False | The user's invite status. | |
| Is App Service Account | Bool | True | Indicates whether the user is a service account created for app integrations. | |
| Is Bot | Bool | True | Indicates whether a user is a bot. | |
| Is Hidden | Bool | True | Indicates whether this user is displayed in most systems. This typically applies to agents or bots, but can include other types of users. | |
| Is Hubspot Generated App Service Account | Bool | True | Indicates whether the user was automatically created as a service account for use in the install of an integration. | |
| Is in working hours | Bool | True | Indicates whether the current time is within this user's working hours. | |
| Is MAM User | Bool | True | Indicates whether the user is a Multi-Account Management (MAM) user. MAM users represent users from other portals associated with your account. | |
| Is out of office | Bool | True | Indicates whether the user is out of office. | |
| Partner | Bool | True | Indicates whether a user is working on this hub on behalf of a Solutions Partner or a Solutions Provider. | |
| Is Work Agent | Bool | True | Indicates whether the user is a service account identifying a HubSpot work agent. | |
| Job Title | String | True | Displays the user's job title. | |
| Language | String | False | Describes what language this user is using. | |
| Last Active | Datetime | True | The last time this user performed actions within the app on desktop or mobile. Updated daily. | |
| Last Password Change | Datetime | True | The last time this user updated their password. | |
| Last Property Updated Time | Decimal | True | The last time this user’s settings or personal details were changed. | |
| Object last modified date/time | Datetime | True | Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically. | |
| Main Phone | String | True | The user's main phone number. | |
| Main User Language Skill | String | False | The main language skill for a user. This is the language the user is most fluent in. | |
| Manager | String | False | The user's manager. Can be any non-deactivated or non-partner user in the account. | |
| Scheduling Pages | Bool | True | Indicates whether personal availability is shared in scheduling pages so prospects can book time on the user's connected calendar. | |
| Merged record IDs | String | False | The list of record IDs that have been merged into this record. This value is set automatically by HubSpot. | |
| Record ID | Decimal | True | The unique ID for this record. This value is set automatically by HubSpot. | |
| Record creation source | String | True | Raw internal PropertySource present in the RequestMeta when this record was created. | |
| Record source detail 1 | String | True | First level of detail on how this record was created. | |
| Record source detail 2 | String | True | Second level of detail on how this record was created. | |
| Record source detail 3 | String | True | Third level of detail on how this record was created. | |
| Record creation source ID | String | True | Raw internal sourceId present in the RequestMeta when this record was created. | |
| Record source | String | False | How this record was created. | |
| Record creation source user ID | Decimal | True | Raw internal userId present in the RequestMeta when this record was created. | |
| Out Of Office Hours | String | True | Collection of user's out of office hours. | |
| Owning Teams | String | False | The teams that are attributed to this record. | |
| Partner User | String | False | The type of partner user (partner or provider), if applicable. | |
| Pinned engagement ID | Decimal | True | The object ID of the current pinned engagement. This is shown in the app only if an association to the engagement already exists. | |
| Pipeline | String | False | This user's current pipeline. | |
| User stage | String | False | The pipeline stage that contains this user. | |
| Read only object | Bool | True | Indicates whether a record can be edited by a user. | |
| SCIM Status | Bool | True | Indicates whether the user is managed by SCIM. | |
| Name | String | True | The user's full name or email. If a first or last name does not exist, the email is returned. | |
| Secondary User Language Skills | String | False | Secondary language skills for a user. These are other languages in which the user is proficient. | |
| Shared teams | String | False | Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs. | |
| Shared users | String | False | Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs. | |
| Standard Time Zone | String | False | The user's time zone. Values use standard time zone identifiers, such as America/New_York or Europe/Dublin. | |
| Timezone Auto Update Enabled | Bool | True | Indicates whether the user's standard time zone updates automatically based on the user's browser location when using timezone-enabled apps. | |
| Uncategorized Skills | String | False | Uncategorized skills of the user. | |
| Unique creation key | String | True | A unique property used for idempotent creates. | |
| Updated by user ID | Decimal | True | The user who last updated this record. This value is set automatically by HubSpot. | |
| User All Accessible Teams | String | False | The main team, extra team, and any child team assigned to the user. | |
| Default Team (Formerly Main Team) | String | False | The assigned primary team of the user. | |
| Team(s) | String | False | The direct (primary and secondary) teams for this user. | |
| User IDs of all notification followers | String | False | The user IDs of all users that have clicked follow within the object to opt in to getting follow notifications. | |
| User IDs of all notification unfollowers | String | False | The user IDs of all object owners that have clicked unfollow within the object to opt out of getting follow notifications. | |
| User IDs of all owners | String | False | The user IDs of all owners of this record. | |
| Extra Teams | String | False | The secondary teams for the user. | |
| Date entered current stage | Datetime | True | The date this object entered its current pipeline stage. | |
| Time in current stage | Datetime | True | The time this object has spent in the current pipeline stage. | |
| Performed in an import | Bool | True | Indicates whether the object is part of an import. | |
| Working Hours | String | True | Collection of user’s working hours. | |
| Owner assigned date | Datetime | True | The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot. | |
| Owner | String | True | The owner of the object. | |
| Owner's main team | String | False | The main team of the record owner. This value is set automatically by HubSpot. |