Employees

Create employee

Create a new employee for a company.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
userId
required
string

The id of the user associated with this employee

managerEmployeeId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The id of the employee's manager

firstName
string

The employee's first name.

lastName
string

The employee's last name.

jobName
string

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

email
string

The employee's email address.

phone
string

The employee's phone number.

externalId
string or null

The lender's external identifier for the employee.

Array of objects
Responses
200

Success

post/companies/{companyId}/employees
Request samples
application/json
{
  • "userId": "string",
  • "managerEmployeeId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "externalId": "string",
  • "teams": [
    ]
}
Response samples
application/json
{
  • "userId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "id": "string",
  • "externalId": "string",
  • "teams": [
    ]
}

Create employee

Create a new employee for a company.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
userId
required
string

The id of the user associated with this employee

managerEmployeeId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The id of the employee's manager

firstName
string

The employee's first name.

lastName
string

The employee's last name.

jobName
string

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

email
string

The employee's email address.

phone
string

The employee's phone number.

externalId
string or null

The lender's external identifier for the employee.

Array of objects
Responses
200

Success

post/employees
Request samples
application/json
{
  • "userId": "string",
  • "managerEmployeeId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "externalId": "string",
  • "teams": [
    ]
}
Response samples
application/json
{
  • "userId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "id": "string",
  • "externalId": "string",
  • "teams": [
    ]
}

Get employees

Get employees

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

teamId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique team identifier.

managerEmployeeId
string^ext-|^[A-Z]{2}-[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
{
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create employee

Update an employee

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
employeeId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique employee identifier.

Request Body schema: application/json
userId
string

The id of the user associated with this employee

managerEmployeeId
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The id of the employee's manager

firstName
string

The employee's first name.

lastName
string

The employee's last name.

jobName
string

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

email
string

The employee's email address.

phone
string

The employee's phone number.

externalId
string or null

The lender's external identifier for the employee.

Array of objects
Responses
200

Success

put/employees/{employeeId}
Request samples
application/json
{
  • "userId": "string",
  • "managerEmployeeId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "externalId": "string",
  • "teams": [
    ]
}
Response samples
application/json
{
  • "userId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "jobName": "string",
  • "email": "string",
  • "phone": "string",
  • "id": "string",
  • "externalId": "string",
  • "teams": [
    ]
}

Get employee by ID

Get employee by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
employeeId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique employee identifier.

Responses
200

Success

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

Add employee to team

Add employee to a team

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
employeeId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique employee identifier.

teamId
required
string^ext-|^[A-Z]{2}-[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^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique employee identifier.

teamId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique team identifier.

Responses
204

Success

delete/employees/{employeeId}/teams/{teamId}