Get Configuration JSON Schema
Returns the machine-readable JSON Schema (Draft 2020-12) for the FMV1 JSON configuration contract — the exact body that import, validate, and compare accept and export returns.
The schema is derived directly from the server’s single source-of-truth validation schema, so it cannot drift from what those endpoints enforce. Fetch it once to learn the shape, the per-slice structure, and the allowed enum values before editing a configuration — it is the resource an automated agent (e.g. an MCP server) stands on to author config edits.
The schema is a framework constant (identical for every company), so the request needs no body — POST an empty object. The response is the literal JSON Schema document, ready to hand to any JSON-Schema validator.
Required permission: company.configuration:export
This endpoint requires an API key created with the FMV1_CONFIGURATION_MANAGER role. See Authentication for how to create API keys with specific roles.
Authorizations
User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.
Path Parameters
Company identifier
Body
No input is required; the schema is a framework constant. An empty object is accepted.
Response
The JSON Schema for the FMV1 configuration contract
A JSON Schema (Draft 2020-12) document describing the FMV1
configuration body. Treated as an opaque schema document — its
top-level keys are the JSON-Schema keywords ($schema, type,
properties, …), not config fields.
