pulse.clients.list()

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

Added in 0.1.0

Parameters

No parameters

Response — ClientListItem[]

Field	Type	Description
uid	number	Unique client identifier
firstName	string \| null	Client first name
lastName	string \| null	Client last name
officeName	string \| null	Provider office name (from ProviderOffice join)
phone	string \| null	Home phone or cell phone (first available)
uciNumber	string \| null	UCI identification number
status	string \| null	Client 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 clients = await pulse.clients.list();

// clients[0].firstName  -> "Maria"
// clients[0].officeName -> "Main Office"
// clients[0].status     -> "Active"

await pulse.disconnect();

Live Preview

[
  {
    "uid": 5444,
    "firstName": "Office",
    "lastName": "Admin",
    "officeName": "Gotham",
    "phone": "(333) 654-9812",
    "uciNumber": null,
    "status": "Active"
  },
  {
    "uid": 5417,
    "firstName": "Captain",
    "lastName": "America",
    "officeName": "Gotham",
    "phone": "(123) 456-5555",
    "uciNumber": "5417854",
    "status": "Active"
  },
  {
    "uid": 7492,
    "firstName": "Noah",
    "lastName": "Ark",
    "officeName": "Living Water",
    "phone": "(530) 986-0798",
    "uciNumber": "33333333",
    "status": "Active"
  }
]