EquiPay Engine — External REST API

The external, admin-token-authenticated REST surface for the EquiPay Engine pay-gap analysis + employee-survey platform.

This is separate from the app’s internal Firebase callables (/functions/<name>, Firebase-token auth). External API clients authenticate with an admin-issued API key sent in the X-API-Key header and are bound to exactly one organization (tenant) with least-privilege scopes.

> Proof-of-concept spec authored for the Blume docs evaluation. It mirrors the > design in docs/api-design.md; endpoints marked planned are not all live yet.

Version 1.0.0

Base URLhttps://paygap-jaggeman.web.app/api/v1https://paygap-prod.web.app/api/v1

Employees

Read the organization’s workforce records (role/scope-minimized).

GETList employees/employees

Surveys

Survey campaign definitions and metadata.

GETList survey campaigns/surveys

Settings

Organization analysis configuration.

GETGet organization settings/settings