API reference

Upload each month's schedule update and read the results from your own scripts, data warehouse or reporting tools.

Authentication

Create a personal token under My reports, API tokens. Send it with every request:

Authorization: Bearer tf_your_token

A token acts as you: it sees the projects and reports you can see, with your team roles. It works only on the /api/v1/ routes below, so it can't change tokens, teams, sign-ins or payments. Revoke a token on the account page at any time. Limit: 1,000 calls an hour.

Projects

GET  /api/v1/projects                 your projects and team projects
GET  /api/v1/projects/{id}            one project: updates, comments, checks
GET  /api/v1/portfolio                every project's latest position, worst first
POST /api/v1/projects/{id}/updates    upload the next update (multipart)
GET  /api/v1/projects/{id}/letter.docx   comment letter (also .xlsx)

Upload fields: current (the XER or XML file, required), previous (optional; without it the project's latest update is used), contract_date (YYYY-MM-DD), ld_rate (daily delay damages), notes.

curl -H "Authorization: Bearer $TF_TOKEN"      -F current=@Update-07.xer      https://gettruefloat.com/api/v1/projects/$PROJECT/updates

The reply carries the report id. Analysis takes seconds to a minute; poll the report until status is done.

Reports

GET /api/v1/reports/{id}              status and summary
GET /api/v1/reports/{id}/result       the full analysis as JSON (add ?gantt=true for every activity)
GET /api/v1/reports/{id}/export.docx  Word report
GET /api/v1/reports/{id}/findings.xlsx   Excel findings

curl -H "Authorization: Bearer $TF_TOKEN" https://gettruefloat.com/api/v1/reports/$REPORT/result

AI assistants (MCP)

TrueFloat is also an MCP server, so Claude, ChatGPT, Cursor and other assistants that support MCP can list your projects, send an update for review and read the findings for you. Address: https://gettruefloat.com/mcp (streamable HTTP), with the same token in the Authorization header.

claude mcp add --transport http truefloat https://gettruefloat.com/mcp      --header "Authorization: Bearer $TF_TOKEN"

Tools: list_projects, portfolio, get_project, create_project, create_upload_link and get_report (sections: summary, red_flags, changes, health, critical_path, float_paths, milestones, lookahead, risk, compliance, period, narrative). Files don't travel through the assistant: create_upload_link returns a one-time address, good for 30 minutes, that the schedule file is sent to. The assistant sees exactly what you can see, under the same plans; there is no extra charge for reading results through it.

Errors

Errors return JSON with an error message: 400 for a bad file or field, 401 for a missing or revoked token, 402 when the report isn't unlocked, 403 when your team role doesn't allow the action, 404 when the item doesn't exist or isn't yours, 429 when over a limit.

Version 1 is stable: fields may be added, never removed or renamed. Questions: admin@gettruefloat.com.