The complete, up-to-date, and community-driven documentation for the GroupMe API.
The GroupMe platform has a vibrant developer community, but the official API documentation has not kept pace with the platform's evolution. This project is a community-led effort to create a comprehensive, accurate, and up-to-date resource for anyone building on the GroupMe API.
Here you will find:
- ✅ Complete Endpoint Reference: Detailed documentation for the v3, v4, and other unlisted API endpoints.
- 📚 In-Depth Guides: Clear explanations of core concepts like the WebSocket gateway, attachments, and the emoji system.
- 🤖 Practical Examples: Working bot examples to help you get started quickly.
- ✨ Undocumented Features: Information on hidden parameters, event types, and API behavior not found anywhere else.
Important
Disclaimer: This documentation is a community effort and is not officially associated with, or endorsed by, GroupMe or Microsoft.
- API Reference - A complete breakdown of all known endpoints.
- Bot Examples - See how to build functional bots.
This project thrives on community contributions! Whether you're fixing a typo, documenting a newly discovered feature, or improving an example, your help is welcome.
To get started, please read our Contributing Guide, which covers:
- How to submit changes and open a pull request.
- The Style Guide for keeping the docs consistent.
Have a question, an idea, or just want to chat with other GroupMe developers?
➡️ Join the GroupMe API Development Chat
This project is under a dual-license model:
- All documentation content is licensed under CC-BY-4.0.
- All source code, including examples and snippets, is licensed under the MIT License.
By contributing, you agree to license your contributions under these terms.