Skip to content
Last updated

Manage employees

Employees are the user accounts that grant access to the CRM, Agent Portal, and Admin Portal. Use the Employees page to add new employees, assign them to teams and roles, and manage their access settings.

Availability: All clients Required permissions: employee:list, employee:read (to view); employee:create (to add); employee:update (to edit)

View employees

From the Admin Portal sidebar, select Employees (beta toggle: under the Workforce group). The employee list displays all employees for your company in a table.

ColumnDescription
IDThe user ID associated with the employee. Select to open the employee detail page.
First NameThe employee's first name.
Last NameThe employee's last name.
UsernameThe email or username used for authentication.
Job NameThe employee's job title or position.
TeamsTeams the employee is assigned to, displayed as a comma-separated list.
RolesRoles assigned to the employee, displayed as badges. System roles (super-admin, api, and Peach-internal roles) are hidden from this list.
InvestorsInvestors the employee is assigned to. If an employee has no investor assignments, they can access all loans. If assigned to one or more investors, they can only access loans belonging to those investors.

Use the search bar to find employees by first name, last name, employee ID, user ID, or external ID (prefix external IDs with ext-).

Add an employee

  1. From the Employees list, select Add employee.
  2. Fill in the employee and authentication details (see field reference below).
  3. Select Add to create the employee.

You're redirected to the employee's detail page after creation.

The fields displayed on the add employee form depend on your company's authentication configuration. See Authentication-dependent fields for details.

Caution: Changing an employee's email or phone in Employee details updates their profile record only — it does not update their login credentials. To change the credentials used for authentication, contact Peach support.

Edit an employee

The employee detail page has two independently editable sections: Employee details and User details. Each section has its own Edit and Save buttons, so you can update one section without affecting the other.

Edit employee details

  1. From the Employees list, select an employee's ID to open their detail page.
  2. In the Employee details section, select Edit.
  3. Update the fields you want to change.
  4. Select Save employee to apply changes, or Cancel to discard.

Edit user details

  1. From the employee's detail page, scroll to the User details section.
  2. Select Edit.
  3. Update the user's Status or Roles.
  4. Select Save user to apply changes, or Cancel to discard.

Employee fields

Employee details

FieldDescriptionRequiredValues / Format
First nameThe employee's first name.YesText, 1-50 characters
Last nameThe employee's last name.YesText, 1-50 characters
Job nameThe employee's job title or position within your company.NoText
EmailThe employee's email address. Also used for authentication if your company uses email-based login.ConditionalValid email address
PhoneThe employee's phone number. Used for 2FA or phone-based authentication if configured.ConditionalUS phone number format
ManagerThe employee's direct manager. Select from existing employees.NoDropdown
TeamsTeams the employee belongs to. An employee can be on multiple teams.NoMulti-select
InvestorsInvestors the employee is restricted to. When set, the employee can only access loans belonging to these investors across all portals.NoMulti-select
External IDYour company's internal identifier for this employee. Read-only after creation.NoText

The following are shown read-only in the Employee details section on the detail page:

FieldDescription
Employee IDThe Peach-assigned identifier for the employee.
Created atThe date and time the employee record was created.
Last updatedThe date and time the employee record was last modified.

User details

FieldDescriptionRequiredValues / Format
StatusThe user's account status. Set to Inactive to disable access without deleting the employee record.YesActive, Inactive
RolesPermission roles assigned to the user. A user can have multiple roles, and permissions are additive across all assigned roles.NoMulti-select (system roles excluded from list)

The following user fields are read-only:

FieldDescription
User IDThe Peach-assigned user identifier.
Authentication methodHow the employee logs in, determined by your company's configuration.
UsernameThe username used for authentication.
Created atThe date and time the user record was created.
Last updatedThe date and time the user record was last modified.

Authentication-dependent fields

The add employee form shows different fields depending on your company's authentication type:

Authentication typeAdditional fields shown
Basic (email + password)password (required), Username (required if auth value type is not email)
SAMLSAML subject name ID (required)
One-time code (phone)Phone (required)