Peach Finance

Employees

Create employee

Create a new employee for a company.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
required
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
userId
required
string

The ID of the user associated with this employee

availableAndPermittedTasktypes
string (TaskType)
Enum: "answerInboundVoiceCall" "handleInboundInteraction" "handleUnboundInboundInteraction" "makeScheduledCall" "replyToNewConvo" "replyToNewText" "replyToNewWebChat" "replyToAbandonedWebChat" "reviewEscalatedCaseAgent" "reviewEscalatedCaseAgentUrgent" "reviewEscalatedCaseTeam" "reviewEscalatedCaseTeamUrgent" "reviewDocumentUpload" "reviewSnoozedCase" "reviewAutoCreatedCase" "reviewAutoUpdatedCase" "reviewCaseInstructions" "reviewVoicemail" "smartReviewCase"
managerEmployeeId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Peach's unique or lender's external identifier.

firstName
string [ 1 .. 50 ] characters

The employee's first name.

lastName
string [ 1 .. 50 ] characters

The employee's last name.

jobName
string or null [ 1 .. 100 ] characters

The name of position in the company—e.g., "CEO", "Agent", "Supervisor"

email
string or null [ 1 .. 100 ] characters

The employee's email address.

phone
string or null [ 1 .. 16 ] characters

The employee's phone number.

externalId
string or null

The lender's external identifier for the employee.

Array of objects (Team)
Responses
200

Success

post/employees
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "userId": "string",
  • "availableAndPermittedTasktypes": "answerInboundVoiceCall",
  • "managerEmployeeId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "externalId": "string",
  • "teams": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get employees

Get employees

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
sortBy
Array of strings

The data attributes by which to sort the results.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

offset
integer >= 0

Offset from the start of results.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

teamId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

** DEPRECATED - use teamIds ** Filter results to a single team.

teamIds
Array of strings (AnyId)

Filter results to employees that belong to at least one of a list of teams.

excludeTeamIds
Array of strings (AnyId)

Filter results to employees that do not belong to any of a list of teams.

managerEmployeeId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The employee ID of the manager

search
string

The search term on which to search. It will match ANY employee when the search term matches the following:

  • case-insensitive matches any substring of an employee's first name
  • case-insensitive matches any substring of an employee's last name
  • if there is whitespace in the search term, split on the whitespace, and case-insensitive match the first part to any substring of an employee's first name and the second part to any substring of the last name
  • exactly matches an employee's user's ID
  • exactly matches an employee's ID
  • exactly matches an employee's external ID (prefixed with ext-)
  • exactly matches one of employee's role IDs
Responses
200

Success

get/employees
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Update employee

Update an employee

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
employeeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique employee identifier.

Request Body schema: application/json
required
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
userId
string

The ID of the user associated with this employee

availableAndPermittedTasktypes
string (TaskType)
Enum: "answerInboundVoiceCall" "handleInboundInteraction" "handleUnboundInboundInteraction" "makeScheduledCall" "replyToNewConvo" "replyToNewText" "replyToNewWebChat" "replyToAbandonedWebChat" "reviewEscalatedCaseAgent" "reviewEscalatedCaseAgentUrgent" "reviewEscalatedCaseTeam" "reviewEscalatedCaseTeamUrgent" "reviewDocumentUpload" "reviewSnoozedCase" "reviewAutoCreatedCase" "reviewAutoUpdatedCase" "reviewCaseInstructions" "reviewVoicemail" "smartReviewCase"
managerEmployeeId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Peach's unique or lender's external identifier.

firstName
string [ 1 .. 50 ] characters

The employee's first name.

lastName
string [ 1 .. 50 ] characters

The employee's last name.

jobName
string or null [ 1 .. 100 ] characters

The name of position in the company—e.g., "CEO", "Agent", "Supervisor"

email
string or null [ 1 .. 100 ] characters

The employee's email address.

phone
string or null [ 1 .. 16 ] characters

The employee's phone number.

externalId
string or null

The lender's external identifier for the employee.

Array of objects (Team)
Responses
200

Success

put/employees/{employeeId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "userId": "string",
  • "availableAndPermittedTasktypes": "answerInboundVoiceCall",
  • "managerEmployeeId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "externalId": "string",
  • "teams": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get employee by ID

Get employee by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
employeeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique employee identifier.

Responses
200

Success

get/employees/{employeeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Add employee to team

Add employee to a team

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
employeeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique employee identifier.

teamId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique team identifier.

Responses
204

Success

put/employees/{employeeId}/teams/{teamId}

Remove employee from team

Remove an employee from a team

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
employeeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique employee identifier.

teamId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique team identifier.

Responses
204

Success

delete/employees/{employeeId}/teams/{teamId}
➔ Next to Teams