# Get Single User

**GET /users/{userName}**

This API call is used to get information for a single user with the given username or id.


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


## Authentication methods
- Bearer auth


## Parameters

### Path parameters
- **userName** (string)
  Username or ID of the user.

### Query parameters
- **include** (string)
  Include additional information for the user.


## 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.

### 404
User Not Found

#### Body: application/json (object)
- **status** (integer)

- **error** (string)



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