pulse.employees.list()

Returns up to 100 active employees with office names and positions, ordered by last name. Joins with ProviderOffice for office name resolution.

Added in 0.1.0

Parameters

No parameters

Response — EmployeeListItem[]

Field	Type	Description
uid	number	Unique employee identifier
firstName	string \| null	Employee first name
lastName	string \| null	Employee last name
currentPosition	string \| null	Current job position
officeName	string \| null	Provider office name (from ProviderOffice join)
phone	string \| null	Cell, work, or home phone (first available)
role	string \| null	Department/role
status	string \| null	Employment status (Active, Inactive, etc.)

Code Example

import { createPulseClient } from '@qsp-life/pulse';

const pulse = createPulseClient({
  server: process.env.PULSE_DB_SERVER!,
  database: process.env.PULSE_DB_DATABASE!,
  user: process.env.PULSE_DB_USER!,
  password: process.env.PULSE_DB_PASSWORD!,
});

const employees = await pulse.employees.list();

// employees[0].firstName       -> "Jane"
// employees[0].currentPosition -> "Direct Support Professional"
// employees[0].officeName      -> "Main Office"

await pulse.disconnect();

Live Preview

[
  {
    "uid": 5498,
    "firstName": "Admin",
    "lastName": "Admin",
    "currentPosition": null,
    "officeName": "Gotham",
    "phone": null,
    "role": null,
    "status": "Active"
  },
  {
    "uid": 9770,
    "firstName": "Rackspace",
    "lastName": "AI",
    "currentPosition": "Magician",
    "officeName": "Gotham",
    "phone": "",
    "role": null,
    "status": "Active"
  },
  {
    "uid": 9730,
    "firstName": "John",
    "lastName": "Angello'",
    "currentPosition": "Coordinator",
    "officeName": "Gotham",
    "phone": "",
    "role": null,
    "status": "Active"
  }
]