---
title: "Get a List of Users"
method: GET
path: "/api/v1/users"
tags: ["User Management"]
---

# Get a List of Users

`GET /api/v1/users`

## Request

- Base URL: `https://api.dealhub.io`
- URL: `https://api.dealhub.io/api/v1/users`
- Auth: HTTP bearer

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.

## Query parameters

- `status` 'active' | 'inactive'

## Response `200`

Success. Returns an array of user objects.

- User[]
  - `login` string: Login of the user.
  - `id` string: DealHub user ID.
  - `email` string, email: Primary email of the user.
  - `name` string: User's full name.
  - `position` string: The role of the user in the organization (job title).
  - `business_title` string: Business title of the user in the CRM organization.
  - `phone` string: User's phone number.
  - `mobile` string: User's mobile phone number.
  - `fax` string: User's fax number.
  - `company` string: User's company name.
  - `street` string: Street name.
  - `city` string: City name.
  - `state` string: State name.
  - `country` string: Country name.
  - `postal_code` string: Postal code.
  - `user_manager_login` string: Login of the user's manager.
  - `is_active` boolean: Flag indicating if the user is active.

## Other responses

- `403`: Forbidden. Invalid or missing authentication token.

---

[API](https://skmtc.dev/dealhub/apis/user-api.md) - [All operations](https://skmtc.dev/dealhub/apis/user-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dealhub/apis/user-api/revisions/e26409536035?raw)