API Reference

All available Pulse methods. Click a method for full documentation.

Quick Start

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

const pulse = createPulseClient(config);
const clients = await pulse.clients.list();

pulse.clients

MethodReturnsDescription
GET.list()
Returns up to 100 active clients with office names, ordered by last name.
GET.getById(id)
Returns full client detail by UID.

pulse.employees

MethodReturnsDescription
GET.list()
Returns up to 100 active employees with office names and positions, ordered by last name.
GET.getById(id)
Returns full employee detail by UID.