Welcome
Collect customer feedback, let users vote on it and publish a roadmap with the LogChimp REST API.
LogChimp is open-source customer feedback software. Its REST API lets you sign users in, collect feedback as posts on boards, record votes, and publish roadmaps, so you can build your own feedback widgets, sync feedback into other tools or automate your LogChimp site.
What you'll find here
- API Reference: all 16 operations grouped by resource (Auth, Site, Posts, Votes, Boards, Roadmaps), with request and response examples and a live API playground.
- SDKs: client libraries for C#, Python and TypeScript, generated by APIMatic, with code samples on every endpoint.
- Context Plugin: brings the LogChimp API and SDKs into AI coding assistants such as Claude Code, Cursor and Codex.
Base URL
LogChimp is self-hosted, so every request goes to your own site, followed by the API version:
https://yourdomain.com/api/v1Set host (and protocol, if you run without TLS locally) to point the playground and SDKs at your instance. See Installation to run one.
Authentication
Sign in with POST /auth/login to get a JWT, then send it as a bearer token:
Authorization: Bearer $LOGCHIMP_TOKENReading public posts, boards and roadmaps works without a token; creating, updating, deleting and voting need one.
Common tasks
- Sign in and get a token:
POST /auth/login - List posts:
POST /posts/get - Create a feedback post:
POST /posts - Upvote a post:
POST /votes - List roadmaps:
GET /roadmaps
Errors
LogChimp uses conventional HTTP status codes: 2xx for success, 4xx when the request was invalid (missing parameter, post not found, missing permission) and 5xx for a problem on your LogChimp server. Error bodies carry a machine-readable code and a human-readable message.