OpenAPI spec

ContactFollowUp ships a hand-written OpenAPI 3.1 description for the most-used endpoints.

Download or stream it from /api-spec.yaml. The spec covers the highest-traffic surfaces today — contacts, companies, deals, tickets, activities, sequences, meetings, forms, appointments, providers, intake-forms, secure messaging, and payments. We're adding the rest as the API surface stabilizes.

Versioning

The spec's info.version tracks the public API version, not the ContactFollowUp app version. Breaking changes will bump the major.

Render it

Pick your favorite viewer:

Swagger Editor — paste in the YAML.
Redoc CLI — npx @redocly/cli build-docs api-spec.yaml -o out.html
Insomnia / Postman — both import the spec directly into a request collection.
VS Code — the 42Crunch.vscode-openapi extension gives inline preview and linting.

Generate a client

TypeScript types

npx openapi-typescript https://app.contactfollowup.com/api-spec.yaml \
  -o src/types/hearthnote.d.ts

Python client

pipx run openapi-python-client generate \
  --url https://app.contactfollowup.com/api-spec.yaml

Spotted a discrepancy?

The spec is hand-written — the routes are the source of truth. If you see a divergence, file an issue or email support@contactfollowup.com. We treat spec/runtime mismatches as bugs.