pulse.employees.getById(id)

Returns full employee detail by UID. Includes identity, address, contact, emergency contact, employment info, demographics, and HR notes. Joins with ProviderOffice.

Added in 0.1.0

Parameters

Name	Type	Description
id	number	The employee UID to look up

Response — EmployeeDetail | null

Field	Type	Description
uid	number	Unique employee identifier
firstName	string \| null	First name
middleName	string \| null	Middle name
lastName	string \| null	Last name
nickName	string \| null	Preferred name
dob	string \| null	Date of birth (YYYY-MM-DD)
ssn	string \| null	Social Security number
photo	string \| null	Photo reference
address1	string \| null	Street address line 1
address2	string \| null	Street address line 2
city	string \| null	City
state	string \| null	State
zip	string \| null	ZIP code
county	string \| null	County
workPhone	string \| null	Work phone
homePhone	string \| null	Home phone
cellPhone	string \| null	Cell phone
faxNumber	string \| null	Fax number
email	string \| null	Email address
emergencyContactName	string \| null	Emergency contact full name
emergencyContactPhone	string \| null	Emergency contact phone
emergencyContactEmail	string \| null	Emergency contact email
currentPosition	string \| null	Current job position
department	string \| null	Department
hireDate	string \| null	Original hire date (YYYY-MM-DD)
activeDate	string \| null	Active date (YYYY-MM-DD)
inactiveDate	string \| null	Inactive date (YYYY-MM-DD)
fullPartTime	string \| null	Full-time or part-time
status	string \| null	Employment status
officeName	string \| null	Provider office name (from ProviderOffice join)
gender	string \| null	Gender
ethnicity	string \| null	Ethnicity
education	string \| null	Education level
primaryLanguage	string \| null	Primary language
hrComments	string \| null	HR comments
comments	string \| null	General comments

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 emp = await pulse.employees.getById(1234);

if (emp) {
  emp.firstName       // "Jane"
  emp.currentPosition // "Direct Support Professional"
  emp.hireDate        // "2022-03-15"
  emp.officeName      // "Main Office"
}

await pulse.disconnect();

Live Preview

{
  "uid": 5498,
  "firstName": "Admin",
  "middleName": null,
  "lastName": "Admin",
  "nickName": null,
  "dob": null,
  "ssn": null,
  "photo": null,
  "address1": null,
  "address2": null,
  "city": null,
  "state": null,
  "zip": null,
  "county": null,
  "workPhone": null,
  "homePhone": null,
  "cellPhone": null,
  "faxNumber": null,
  "email": "dev@quicksolveplus.com",
  "emergencyContactName": null,
  "emergencyContactPhone": null,
  "emergencyContactEmail": null,
  "currentPosition": null,
  "department": null,
  "hireDate": null,
  "activeDate": null,
  "inactiveDate": null,
  "fullPartTime": null,
  "status": "Active",
  "officeName": "Gotham",
  "gender": null,
  "ethnicity": null,
  "education": null,
  "primaryLanguage": null,
  "hrComments": null,
  "comments": null
}