Sign in
Users

Retrieves a user

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

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.

seatNamesstring[]
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

Changed in 9 of the 53 revisions of this API.115

  • v3b5b726b641263See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

    • ○

      added the optional property seatNames to the response with the 200 status

      response-optional-property-added

  • v30cf03274b2c81See the full diff
    • ○

      endpoint added

      endpoint-added

  • v388afd8abb54e1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

  • v30cf03274b2c82See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • v37742dcf4e0c92See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v39985884c71612See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • v30cf03274b2c82See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • v3c46ef3b41b5f2See the full diff
    • ○

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

      api-security-scope-added

    • ○

      the security scope public-users-read was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3d3d93d6d6ee21See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog