Recommended path
- Read the Public API overview to understand route families and company scoping.
- Configure OAuth credentials in FITsociety and request a Bearer token.
- Read the contracts page before writing production code. It defines response envelopes, validation behavior, idempotency, pagination, rate limits, and field stability.
- Use the API Reference tab for endpoint-level request and response details.
- Use the domain guides for extra validation rules, privacy notes, and business guardrails.
Sections
- Docs contains conceptual guides, validation rules, output contracts, and product-specific integration notes.
- API Reference is generated from the Public API OpenAPI contract and is the source for endpoint-level method, path, parameter, request body, and response details.
- MCP documents the AI tool interface and keeps its grants, OAuth metadata, and runtime endpoint separate from the REST Public API.
- Changelog lists externally relevant developer API documentation and contract changes.
Versioning
The current REST developer surface is/public/v1. Existing fields remain
stable for the lifetime of v1. New fields may be added in a backward-compatible
way, but sensitive or internal model fields are not automatically exposed just
because they exist in backend models.