Skip to content

API Overview

GroupMe has a thriving developer community which has created a variety of applications, bots, and tools. However, while the platform has constantly matured, the public documentation has not. In an effort to help other developers understand and utilize the platform better, this is a community-led effort to document everything possible. If you discover something not listed here, or you find an error in what is listed, please bring it up on the discussion page or submit a pull request.

Much of this information is pulled from dev.groupme.com, which is the official GroupMe developers site. However, most of its information is outdated or incomplete, so please help keep this repo up-to-date.

If you have any questions or would like to get in touch, please join the GroupMe API Development Group or open an issue.

This documentation is not associated with GroupMe or Microsoft

  • Webhook Bots – How to create, index, and manage bots
  • Websocket Gateway – How to connect to the Push service to get real-time interaction with your program
  • Account Management – How to access/update information about your account, turning on/off SMS mode, and configuring profile details
  • Group Management – How to manage groups, members, and messages
  • Direct Messages – How to list, read, and send DMs, as well as how to block/unblock users
  • Conversation Management – How to make calls allowed in both DMs and Groups, such as creating calendar events, pinning messages, reacting to messages and more
  • Common API Structures – How to leverage common structures used in the API, such as attacments, emojis, and system events
  • CDN Management – How to upload Images to GroupMe's CDN