API Reference
Base URL
https://api.example.com/v2
Client-scoped endpoints are nested under /clients/{client_id}. Catalog endpoints (shared reference data) are at the root.
Domains
| Domain | Base path | Description |
|---|---|---|
| Setup | /setup | Bootstrap partner, client, and partner user from LM token claims |
| Clients | /clients/{client_id} | Client organization details, partner info, enrollment token |
| Users | /clients/{client_id}/users | User management, department assignments, and summary stats |
| Departments | /clients/{client_id}/departments | Department CRUD and bulk membership operations |
| Devices | /clients/{client_id}/devices | Device inventory, summary stats, users, and deployment history |
| Apps | /clients/{client_id}/apps | Client-scoped apps, favorites, and license tracking |
| Analytics | /clients/{client_id}/analytics | Time-series activity, aggregate utilization, and AI app usage data for users, devices, and apps |
| Catalog Apps | /catalog-apps | Shared application catalog with vendor/category data, URL patterns, and desktop aliases |
| Catalog Vendors | /catalog-vendors | Application vendors |
| Catalog Categories | /catalog-categories | Application categories |
Design
All v2 endpoints follow the conventions in the Design Guidelines, including cursor-based pagination, consistent error envelopes, embedding rules for related data, DTO naming (Ref vs full entity), and the analytics time-series pattern.
Implementation
The NestJS Class Validators doc contains generated TypeScript DTOs with class-validator decorators for all request and response shapes across every domain.
Open items
See Open Questions for design decisions pending team discussion.