A quick word on API 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.

Questions? Check out our GroupMe API Support Google Group.