Employee API
Summary
This section documents the source-confirmed Employee HTTP surface: 12 direct endpoints, 13 compatibility endpoints, and 3 internal foundation endpoints. It describes exposed contracts only; database internals and event payloads are outside this epic.
Audience
- Frontend and backend developers
- QA and integration engineers
- Support engineers and solution architects
Overview
Use the direct pages for approved Employee Service integration work, the compatibility pages only for gateway-cutover consumers, and the foundation page only for internal discovery. Production route maturity remains transitional.
API scope
| Group | Prefix | Endpoints | Maturity | Documentation |
|---|---|---|---|---|
| Direct Employee | /employee | 12 | Transitional | Management, search, timeline, lookups |
| Compatibility | /api | 13 | Compatibility / Transitional | Employees, organization |
| Employee domain | /api/employee-domain | 3 | Internal | Foundation |
Prerequisites
The host accepts Bearer authentication and the gateway forwards downstream request context. The reviewed route groups do not attach an authentication or authorization requirement, so the effective access requirement is Requires confirmation. Direct data operations require tenant context. Use only an approved gateway and authenticated tenant context; do not call a service instance directly unless an approved integration environment explicitly supports it.
Transitional routing notice
The gateway can route compatibility prefixes to either the monolith or Employee Service during cutover. The direct /employee surface is an Employee Service route. Clients must not assume that compatibility and direct DTOs or error bodies are interchangeable.
Pages
- API overview
- Authentication and context
- Response and error model
- Compatibility and routing
- Testing guide
- Employee management
- Employee search
- Employee timeline
- Organization lookups
- Compatibility employees
- Compatibility organization
- Employee-domain foundation
Limitations
- Endpoint-level authentication and authorization enforcement is Requires confirmation.
- The APIs have no explicit URL version segment or negotiated version contract.
- Runtime Swagger/OpenAPI is enabled, but no committed Employee OpenAPI artifact or generated XML-comment reference was found.
- Compatibility behavior remains transitional and may differ depending on gateway destination.
- Formal .NET test projects were not found in the reviewed backend tree.
Related Articles
- Employee business documentation
- Employee Service architecture
- Organization overview
- Identity overview
See Also
- Gateway and request routing
- Troubleshooting
- Future Employee database and event sections (Not implemented)
Keywords
- Employee API
- HTTP contracts
- Compatibility routing
Revision Information
- Status: Draft
- Last reviewed: 2026-07-15
- Review cycle: Quarterly