HUhubspot
Users

Retrieves a user

Changed on

Retrieves a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.

get/settings/users/2026-09/{userId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/settings/users/2026-09/{userId}
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.users.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: settings.users.read

Path parameters

userIdstring required

The unique identifier of the user to retrieve.

Query parameters

idProperty'EMAIL' | 'USER_ID'

Specifies the property used to identify the user. Valid values are 'USER_ID' and 'EMAIL'.

Response

successful operation

emailstring required

The email address of the user. This is a required field and must be unique.

firstNamestring

The first name of the user, represented as a string.

idstring required

The unique identifier for the user, represented as a string.

lastNamestring

The last name of the user, represented as a string.

primaryTeamIdstring

The ID of the primary team to which the user belongs, represented as a string.

roleIdstring

A string representing a single role ID assigned to the user.

roleIdsstring[] required

An array of strings representing the IDs of the roles assigned to the user. This is a required field.

seatNamesstring[]

An array of strings representing the names of seats assigned to the user.

secondaryTeamIdsstring[]

An array of strings representing the IDs of secondary teams to which the user is associated.

sendWelcomeEmailboolean

A boolean indicating whether a welcome email should be sent to the user.

superAdminboolean required

A boolean indicating whether the user has super admin privileges. This is a required field.

Changes

  • 2026-099aa42e094343Revision changes
    • info

      the security scope crm.objects.users.read was added to the endpoint's security scheme oauth2

    • info

      the security scope settings.users.read was removed from the endpoint's security scheme oauth2

  • 2026-091ec62479c06aRevision changes
    • info

      the security scope crm.objects.users.read was added to the endpoint's security scheme oauth2

    • info

      the security scope settings.users.read was removed from the endpoint's security scheme oauth2