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-03/{userId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/settings/users/2026-03/{userId}
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Path parameters

userIdstring required

Query parameters

idProperty'EMAIL' | 'USER_ID'

Response

successful operation

emailstring required

The user's email.

firstNamestring

The user's first name.

idstring required

The user's unique ID.

lastNamestring

The user's last name.

primaryTeamIdstring

The user's primary team

roleIdstring

The user's role.

roleIdsstring[] required

A list of role IDs assigned to the user.

secondaryTeamIdsstring[]

The user's additional teams.

sendWelcomeEmailboolean

Whether a welcome email was sent to the user. This value will only be populated in response to a provisioning request. Subsequent queries will be false.

superAdminboolean required

Whether the user has super admin privileges.

Changes

  • b0d8bc008db9Revision changes
    • info

      api operation id get-/settings/users/2026-03/{userId}_getById removed and replaced with get-/settings/users/2026-03/{userId}

    • info

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

    • info

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

  • 3578967e48dfRevision changes
    • info

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

    • info

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

Some revisions have not been checked yet.