# Get Users

**GET /users**

This API call is used to retrieve users.

This API call can be executed with or without parameters. When called without any parameters, it will return all users. However, you can also include a `searchText` parameter to limit the response to a specific subset of users.

Note: If your system has a large number of users, it is recommended to include the `page` and `size` parameters in your API call for efficient pagination and retrieval of user data. This allows you to retrieve users in smaller, manageable batches.
### Deactivated Users
Deactivated users will be returned from this call.
- requests with the filter parameter `active=true` will exclude deactivated users from the response.



## Servers
- Sandbox server URL: https://localhost:8080 (Sandbox server URL)


## Authentication methods
- Bearer auth


## Parameters


### Query parameters
- **searchText** (string)
  Find users whose username, first name, or last name begins with the specified searchText value.
- **active** (string)
  Filter users by their activation status. Use "true" to return active users and "false" to return deactivated users.
- **lockedOut** (string)
  Filter users based on their locked-out status. Use "true" to return locked-out users and "false" to return users who are not locked out.
- **page** (integer)
  The page number, starting from 1, used in combination with the "size" parameter to retrieve results in a paginated format.
- **size** (integer)
  The number of records to include in each page of results.
- **include** (string)
  Specify additional information to include for the user. Options are "lastlogin" or "activities".


## Responses
### 200
Successful Response

#### Body: application/json (object)
- **id** (string)
  The unique identifier of the user.
- **userName** (string)
  The username of the user.
- **name** (object)

- **email** (string)

- **phoneNumber** (string)

- **roles** (array[object])

- **userAccess** (object)

- **departmentId** (string)
  The department code value.
- **locationId** (string)
  The location code value.
- **programAdminRoleId** (string)
  The program admin role.
- **match** (object)

- **createdDate** (string)
  The date and time when user was created.
- **active** (boolean)
  Indicates whether the user is active or inactive.
- **lockedOut** (boolean)
  Indicates whether the user is currently locked out from accessing the system.

### 401
Authentication Error. Invalid credentials.

#### Body: application/json (object)
- **code** (string)

- **message** (string)

- **description** (string)


### 403
Authorization Error. Invalid role for request.


[Powered by Bump.sh](https://bump.sh)