# Outlet Flutter API handoff

**Audience:** Flutter app developer. This folder documents requests, responses, user-facing errors, roles, and integration behavior. It is not an implementation guide for the server.

**Start here:** `../shared/response-envelope.md` and `../shared/frontend-integration-checklist.md`.

**API prefix:** `/api/v1`. All endpoint examples are illustrative until checked against a deployed environment. Some module documents contain legacy response examples; apply the shared envelope contract to the response wrapper while retaining the endpoint-specific `data` fields.

**Current rollout:** the Capitalix-style response contract is proposed on a GitLab feature branch; no merge or staging validation yet. Do not assume production has switched.

Read each module `.md` file for its endpoints, inputs, authorization, pagination and errors. Unverified details are flagged in their source documents.
