Skip to content

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

Contents:

  • Bots – How to create, index, and use bots
  • Group Management – How to create, join, list, update, etc. groups
  • Subgroup Management – How to work with subgroups within a parent group
  • Member management – How to add, remove, and update members in a group
  • Group Messages – How to list and send messages in groups
  • Calendar Events – How to list, create, and edit calendar events in a group
  • Polls – Information on how to make and view polls
  • Message Events – How to parse system message events
  • Directory Management – How to list, search, and join public and campus group directories
  • Direct Messages – How to list, read, and send DMs, as well as how to block/unblock users
  • Users/Contact Management – How to create, destroy, and manage contacts; as well as fetch info on other users outside of groups
  • Attachments – Information on how message attachments work, as well as how to upload images to be sent as attachments
  • Reactions – How to react to messages, and how to see your reactions and the likes leaderboard in groups
  • Pins – How to use GroupMe's message pinning functionality
  • Emoji – How GroupMe's custom emoji system works, as well as how to display and send emoji
  • Videos – Information on how to upload videos to be sent as attachments
  • Image Service – How to upload Images to GroupMe's CDN
  • Account Management – How to access/update information about your account, turning on/off SMS mode, and configuring profile details
  • Oauth/MFA – How to manage API tokens and handle multi-factor authentication with GroupMe
  • Websocket Gateway – How to connect to the Push service to get real-time interaction with your program

Contributing

The GroupMe Community Docs are constantly evolving and updating! Check out the Contributing Checklist for insights on what documentation we're still in need of for full API coverage.