v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB

User Management

Get a List of Users

Retrieves a list of users. If no parameters are provided, it will retrieve all users. Fields with null values will not be included in the response.

get/api/v1/users

status'active' | 'inactive'

Filter users by their active or inactive status.

Success. Returns an array of user objects.

loginstring

idstring

DealHub user ID.

emailstring email

Primary email of the user.

namestring

User's full name.

positionstring

The role of the user in the organization (job title).

business_titlestring

Business title of the user in the CRM organization.

phonestring

User's phone number.

mobilestring

User's mobile phone number.

faxstring

User's fax number.

companystring

User's company name.

streetstring

Street name.

citystring

City name.

statestring

State name.

countrystring

Country name.

postal_codestring

Postal code.

user_manager_loginstring

is_activeboolean

Flag indicating if the user is active.