Technical Writer to Document API Endpoints

Skills Required

Description

API endpoints are working fine — but our documentation is a mess. We need a technical writer who can take raw backend notes and turn them into clear, usable API docs for our internal team and third-party developers.

This includes documenting request/response formats, required headers, error codes, and usage examples. Some endpoints are simple, others handle more complex workflows like user permissions and webhook triggers.

You’ll work directly with our lead developer, who will explain each endpoint, logic, and known edge cases. No need to guess — but you should be comfortable reading basic JSON and understanding REST structure.

Output should be organized, well-formatted, and developer-friendly. You can use Markdown or Notion — whatever you’re comfortable with, as long as it’s clean and searchable.

This is an ongoing need. First batch is about 20–25 endpoints, but more will follow as we build.