Documentation

We're sorry, but we have to temporarily disable creating new oauth applications while Microsoft Legal updates our API terms of service.

Questions? We'd love to hear them. Join this group for quick support on your GroupMe API project: https://groupme.com/join_group/4011747/T3HvVO

Reference

Authentication

To obtain an access token, you must authenticate via OAuth 2.0 implicit authentication.

The official specs may seem intimidating, but the process is straightforward:

1. You send your user to a URL on our server, passing us your client ID.

https://api.groupme.com/oauth/authorize?client_id=CLIENT_ID

2. Your user will be asked to log in and authorize your application.

3. We will redirect them to the callback URL you registered when you set up your client ID.

https://YOUR_CALLBACK_URL/?access_token=ACCESS_TOKEN

Using the Access Token

You must make requests with your access token using the token parameter.

GET https://api.groupme.com/v3/groups?token=ACCESS_TOKEN

Alternatively, you can send your token in the X-Access-Token header.

GET /v3/groups HTTP/1.1
User-Agent: CoolApp/2.0
Host: api.groupme.com
Accept: */*
X-Access-Token: ACCESS_TOKEN

Responses

All responses come in a request envelope:

{
  response: { ... },
  meta: {
    code: 400,
    errors: ["Name is required"]
  }
}

response

The target or resulting object. Sometimes a list with additional meta data.

meta.code

For clients that cannot read HTTP status codes.

meta.errors

If you receive 4XX response codes, you can expect an array of errors.

Data Types

• IDs are unordered alphanumeric strings.
• Timestamps are integer seconds since the UNIX epoch.
• Phone numbers are sent as +<country code> <number>

Format

All data is sent and received as JSON.

While most requests will work as expected with standard HTTP params, it is especially important to send data as JSON in the request body to ensure consistent hash ordering (e.g. when sending multiple members).

Status Codes

We try to return the most appropriate HTTP status code.