Groups.io API Reference

API Reference - ALPHA

The Groups.io API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. JSON is returned by many API responses, when appropriate, including errors.

Note: The API is under active development. Items marked [NI] mean they are not yet implemented.

There is a group to discuss the API. If you have questions about the API or suggestions for improvements of the API or the docs, please post them there.

API Endpoints

The endpoint for accessing all groups a person is subscribed to is groups.io/api. If a person is subscribed to one or more enterprise groups, accessing just those groups can be done through the enterprise domain.

Versioning And Change Log#

NOTE During development, we sometimes need to make backwards incompatible changes. If this happens during development, we will not be changing API versions.

View the changelog to see changes between different versions.

What changes does Groups.io consider to be “backwards-compatible”?

Adding new API resources.
Adding new optional request parameters to existing API methods.
Adding new properties to existing API responses.
Changing the order of properties in existing API responses.
Changing the length of object IDs or other opaque strings.
You can safely assume object IDs we generate will never exceed 255 characters, but you should be able to handle IDs of up to that length. If for example you’re using MySQL, you should store IDs in a VARCHAR(255) COLLATE utf8_bin column (the COLLATE configuration ensures case-sensitivity in lookups). Adding new event types.

Success#

Groups.io uses conventional HTTP response codes to indicate the success or failure of an API request. HTTP response code 200 indicates success and HTTP response code 400 indicates an error. In addition, some endpoints need to return additional information on success. In these instances, a success object is returned with the additional information. This object is returned with the HTTP 200 response code.

Response Attributes

object string value is "success"	String representing the object’s type. Objects of the same type share the same value.
extra	Extra information, endpoint specific.

Example Success Response

    {
      "object": "success",
      "extra": "pending post"
    }

Errors#

Groups.io uses conventional HTTP response codes to indicate the success or failure of an API request. HTTP response code 200 indicates success and HTTP response code 400 indicates an error. In addition, when there is an error, an error object is returned, containing details of the error.

All API calls return an error object when there is an error, in addition to returning an HTTP 400 error code. Errors specific to API calls are listed with each API call. General errors, that can happen with any API call, are listed in this section.

Response Attributes

object string value is "error"	String representing the object’s type. Objects of the same type share the same value.
type	The type of error returned.
extra	Extra information, error specific.

General Errors

unauthorized_error	Incorrect email address or password.
bad_request	Incorrect parameters passed in. For example, a group id that doesn't exist.
authentication	Failure to properly authenticate yourself in the request.
expired	The supplied authentication token is too old.
rate_limit	Too many requests hit the API too quickly.
inadequate_permissions	You do not have permission to execute the specific API call.
invalid_value	When a value is unrecognized. The `extra` field will be set to the name of the field with the invalid value.
server	There was a problem with the server. Please try again later.
bad_csrf	The endpoint required a valid `csrf` parameter. The parameter was either missing or incorrect.

HTTP status code summary

200 OK	Everything worked as expected.
400 Bad Request	The request was unacceptable, often due to missing a required parameter.
429 Too Many Requests	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

Example Error Response

    {
      "object": "error",
      "type": "unauthorized",
      "extra": ""
    }

Pagination#

Some API resources support pagination. These calls take at least these query parameters: limit, page_token, sort_field, sort_dir. Their responses use the list response format defined below.

Groups.io utilizes cursor-based pagination via the page_token and next_page_token parameters. For the first call to an endpoint that supports paging, do not include the page_token parameter. The response will include a next_page_token number. To fetch the next page of results, call the endpoint with page_token set to the next_page_token number.

Query Parameters

limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be 'asc' or 'desc'.

List Response Format

object string value is "list"	String representing the object’s type. Objects of the same type share the same value.
total_count number	The total number of items.
start_item number	The index of the first item returned.
end_item number	The index of the last item returned.
has_more boolean	Whether or not there are more elements available after this set. If `false`, this set comprises the end of the list.
next_page_token opaque	To fetch the next page, set the `page_token` value to this number. This should be considered an opaque value.
data array	An array containing the actual response elements, paginated by any request parameters.

Example Response

{
  "object": "list",
  "total_count": 2,
  "start_item": 1,
  "end_item": 2,
  "has_more": false,
  "next_page_token": 0,
  "data": [
    {
      "id": 701,
      "object": "subscription",
      "created": "2017-08-15T13:58:22.618029196-07:00",
      "updated": "2017-08-15T13:58:22.618029196-07:00",
      "user_id": 147,
      "group_id": 4,
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_normal",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_small",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_none",
      "pending_msg_notify": "sub_notify_email",
      "pending_sub_notify": "sub_notify_email",
      "sub_notify": "sub_notify_email",
      "storage_notify": "sub_notify_email",
      "sub_group_notify": "sub_notify_email",
      "message_report_notify": "sub_notify_email",
      "mod_permissions": "",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "email": "john@smith.com",
      "user_status": "user_status_confirmed",
      "user_name": "",
      "timezone": "",
      "full_name": "John Smith",
      "about_me": "",
      "about_format": "about_html",
      "location": "",
      "website": "",
      "profile_photo_id": "",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "moderator_notes": "",
      "moderator_notes_updated": "1969-12-31T16:00:00-08:00",
      "use_signature": false,
      "use_signature_email": false
    },
    {
      "id": 702,
      "object": "subscription",
      "created": "2017-08-15T13:58:22.618029196-07:00",
      "updated": "2017-08-15T13:58:22.618029196-07:00",
      "user_id": 147,
      "group_id": 4,
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_normal",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_small",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_none",
      "pending_msg_notify": "sub_notify_email",
      "pending_sub_notify": "sub_notify_email",
      "sub_notify": "sub_notify_email",
      "storage_notify": "sub_notify_email",
      "sub_group_notify": "sub_notify_email",
      "message_report_notify": "sub_notify_email",
      "mod_permissions": "",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "email": "john@smith.com",
      "user_status": "user_status_confirmed",
      "user_name": "",
      "timezone": "",
      "full_name": "John Smith",
      "about_me": "",
      "about_format": "about_html",
      "location": "",
      "website": "",
      "profile_photo_id": "",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "moderator_notes": "",
      "moderator_notes_updated": "1969-12-31T16:00:00-08:00",
      "use_signature": false,
      "use_signature_email": false
    }
  ]
}

Libraries#

The following are unofficial libraries.

JAVA	github.com/lake54/groupsio-api-java

Authentication

Authentication#

Authentication to the API is performed via HTTP cookies, using cookies set from the login API call.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

group_id required integer	ID of the group. Either `group_id` or `group_name` can be specified. If neither is specified, a user's set of groups is used.
group_name required string	Name of the group. Either `group_id` or `group_name` can be specified. If neither is specified, a user's set of groups is used.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional number	If 1, then extended information is also returned with the call.

topic_id required integer	ID of the topic to return.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be `asc` or .
extended optional number	If 1, then extended information is also returned with the call.

"bad_request"	"invalid topic_id" is returned if the topic id is missing or invalid.

group_id required integer	ID of the group. Either `group_id` or `group_name` can be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` can be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be `asc` or .
extended optional number	If 1, then extended information is also returned with the call.

group_id required integer	ID of the group. Either `group_id` or `group_name` can be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` can be specified.
q optional string	The query string.
collapse_topics optional boolean	If the results should collapse topics.
exclude_sigs optional boolean	If signature matches should be excluded from the results.
start_date optional string date-time	The start date of the search, in the user's timezone.
end_date optional string date-time	The end date of the search, in the user's timezone.
preset_date_range optional string	Limit the search to a preset date range. Can be: `past_hour`, `past_24_hours`, `past_week`, `past_month`, `past_year`. This is only considered if neither `start_date` nor `end_date` are specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be `asc` or .

Chats

There are several aspects to the Chat system.

The Chat object represents a chat.
Chats can be subscribed to.

New Chat#

Create a new chat. The chat is created and the user is subscribed to the chat.

Permissions Needed

You must have the manage_chats permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
subject required string	The subject of the chat.
desc required string	The description of the chat, in HTML format.
announce required bool	If `true`, send an announcement of the chat to the group.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a chat object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid subject" is returned if the subject is missing or invalid.
"bad_request"	"invalid desc" is returned if the desc is missing or invalid.

POST /api/v1/newchat

$ curl "https://groups.io/api/v1/newchat" \
-b "cookies.curl" \
-d group_id=12&subject=Test&desc=testing&csrf=1234

Example Successful Response:View Chat definition

 {
 "id": 49,
 "object": "chat",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 28,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "group_id": 18,
 "subject": "The chat subject",
 "desc": "This is the description of the chat",
 "is_closed": false,
 "num_messages": 84,
 "chat_sub": 
   {
    "id": 3,
    "object": "chat_sub",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 24,
    "group_id": 47,
    "chat_id": 12,
    "last_msg_seen": 32,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Chat#

Update a chat object.

Permissions Needed

You must be the owner of the chat.

POST Parameters

chat_id required integer	ID of the chat to update. You must be the owner of the chat.
csrf required string	The `csrf_token` from the user object returned when first logged in.
subject optional string	The subject of the chat.
desc optional string	The description of the chat, in HTML format.
is_closed optional boolean	If the chat is closed.

Returns

Returns the chat object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid chat_id" is returned if the chat id is missing or invalid.

POST /api/v1/updatechat

$ curl "https://groups.io/api/v1/updatechat" \
-b "cookies.curl" \
-d chat_id=12&subject=Test&desc=testing&csrf=1234

Example Successful Response:View Chat definition

 {
 "id": 16,
 "object": "chat",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 39,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "group_id": 40,
 "subject": "The chat subject",
 "desc": "This is the description of the chat",
 "is_closed": false,
 "num_messages": 86,
 "chat_sub": 
   {
    "id": 51,
    "object": "chat_sub",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 76,
    "group_id": 40,
    "chat_id": 51,
    "last_msg_seen": 44,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Chats#

Get chats. Chats are returned using the pagination request and object format.

Permissions Needed

You must have the view_chats permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
show_closed optional boolean	If `true`, return closed chats. Otherwise return open chats.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns a chat list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/getchats

$ curl "https://groups.io/api/v1/getchats?group_id=12" \
-b "cookies.curl"

Example Successful Response:View Chat List definition

 {
 "object": "list",
 "total_count": 64,
 "start_item": 5,
 "end_item": 83,
 "has_more": false,
 "next_page_token": 1,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 90,
    "object": "chat",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 2,
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
    "group_id": 58,
    "subject": "The chat subject",
    "desc": "This is the description of the chat",
    "is_closed": false,
    "num_messages": 67,
    "chat_sub": 
      {
       "id": 31,
       "object": "chat_sub",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 78,
       "group_id": 54,
       "chat_id": 22,
       "last_msg_seen": 23,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Chat#

Delete a chat object.

Permissions Needed

You must be the owner of the chat.

POST Parameters

chat_id required integer	ID of the chat to delete. You must be the owner of the chat.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"invalid chat_id" is returned if the chat id is missing or invalid.

POST /api/v1/deletechat

$ curl "https://groups.io/api/v1/deletechat" \
-b "cookies.curl" \
-d chat_id=12&csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Join Chat#

Join a chat.

Permissions Needed

You must have the view_chats permission to use this call with a group.

POST Parameters

chat_id required integer	ID of the chat to join.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a chat sub object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid chat_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid chat_id" is returned if the chat id is missing or invalid.
"bad_request"	"closed chat" is returned if the chat has been closed.
"bad_request"	"already subscribed" is returned if the user is already subscribed to the chat.

POST /api/v1/joinchat

$ curl "https://groups.io/api/v1/joinchat" \
-b "cookies.curl" \
-d chat_id=12&csrf=1234

Example Successful Response:View Chat Sub definition

 {
 "id": 42,
 "object": "chat_sub",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 8,
 "group_id": 43,
 "chat_id": 68,
 "last_msg_seen": 66,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Chat Members#

Get a list of the members of the chat.

Permissions Needed

You must be subscribed to the chat.

POST Parameters

chatsub_id required integer	ID of the chatsub. You must be the owner of the chatsub.

Returns

Returns a member info list object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid chatsub_id" is returned if the chatsub id is missing or invalid.
"bad_request"	"closed chat" is returned if the chat has been closed.

POST /api/v1/chatmembers

$ curl "https://groups.io/api/v1/chatmembers" \
-b "cookies.curl" \
-d chatsub_id=12&csrf=1234

Example Successful Response:View Member Info List definition

 {
 "object": "list",
 "total_count": 10,
 "start_item": 35,
 "end_item": 40,
 "has_more": false,
 "next_page_token": 4,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 62,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 57,
    "group_id": 15,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 71,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 39,
    "pending_subs": 30,
    "pending_msgs": 13,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Leave Chat#

Leave a chat. Generally you do not want to use this. The normal way to leave a chat is to send a /leave message to an open chat.

Permissions Needed

You must be subscribed to the chat.

POST Parameters

chatsub_id required integer	ID of the chatsub to delete. You must be the owner of the chatsub.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"invalid chatsub_id" is returned if the chatsub id is missing or invalid.

POST /api/v1/leavechat

$ curl "https://groups.io/api/v1/leavechat" \
-b "cookies.curl" \
-d chatsub_id=12&csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Chat History#

Get chat history. Chat messages are returned using the pagination request and object format.

Permissions Needed

You must be subscribed to the group.

GET Parameters

chat_id required integer	ID of the chat to view.

Returns

Returns a chat message list object if successful. Returns an error if there is an error. Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid chat_id" is returned if the chat id is missing or invalid.

GET /api/v1/getchathistory

$ curl "https://groups.io/api/v1/getchathistory" \
-b "cookies.curl" \
-d chat_id=12

Example Successful Response:View Chat Message List definition

 {
 "object": "list",
 "total_count": 0,
 "start_item": 59,
 "end_item": 20,
 "has_more": false,
 "next_page_token": 83,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 70,
    "object": "chat_message",
    "created": "2009-11-10T15:00:00-08:00",
    "version": 84,
    "user_id": 47,
    "group_id": 10,
    "chat_id": 65,
    "type": "chat_msg_type_closed",
    "message": "",
    "msg_num": 62,
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Chat Data#

This is a websocket endpoint for sending and receiving chat messages. Once established, the client can post messages to the chat room using chat post objects. The client will receive a series of chat message objects representing posts from other members of the chat room. If no_history is not specified, upon establishment of the connnection, the most recent 50 chat_message objects are returned.

Permissions Needed

You must be subscribed to the chat.

POST Parameters

chatsub_id required integer	ID of the chatsub to enter. You must be the owner of the chatsub.
csrf required string	The `csrf_token` from the user object returned when first logged in.
no_history optional boolean	If `true`, do not automatically send back recent chat history.

Returns

Returns a series of a chat message objects if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid chatsub_id" is returned if the chatsub id is missing or invalid.
"bad_request"	"closed chat" is returned if the chat is closed.

WSS /api/v1/chatdata

$ curl -i -N \
--no-buffer \
-H "Connection: Upgrade" \
-H "Upgrade: websocket" \
-H "Host: api.groups.io" \
-H "Origin: https://api.groups.io" \
-H "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" \
-H "Sec-WebSocket-Version: 13" \
-b "cookies.curl" \
https://groups.io/api/v1/chatdata?chatsub_id=12&csrf=1234

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Drafts

A draft represent a post as it is being written. The sequence to post a message to a group is as follows:

Create a new draft with /newdraft.
Compose the message, periodically saving it with /updatedraft.
Optionally add attachments, using /addattachments.
Once complete, sending the draft as a message with /postdraft.

There are also several draft maintenance endpoints.

New Draft#

Create a new draft object.

Permissions Needed

You must have the can_post permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
draft_type required string	Type of draft. Currently, `draft_type_post` and `draft_type_reply` are the only allowed types.
csrf required string	The `csrf_token` from the user object returned when first logged in.
message_id conditional integer	If this is a 'draft_type_reply', you must specify the ID of the message you are replying to.

Returns

Returns the draft object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid draft_type" is returned if the draft type is missing or invalid.

POST /api/v1/newdraft

$ curl "https://groups.io/api/v1/newdraft" \
-b "cookies.curl" \
-d group_id=12&csrf=12345

Example Successful Response:View Draft definition

 {
 "id": 29,
 "object": "draft",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 20,
 "group_id": 48,
 "draft_type": "",
 "subject": "",
 "body": "",
 "body_type": "",
 "is_special": false,
 "num_attachments": 56,
 "next_attachment_id": 95,
 "message_id": 66,
 "bcc_me": false,
 "bcc_all": false,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Draft#

Update a draft object.

Permissions Needed

You must be the owner of the draft.

POST Parameters

draft_id required integer	ID of the draft to update. You must be the owner of the draft.
csrf required string	The `csrf_token` from the user object returned when first logged in.
subject optional string	Subject of the draft.
body optional string	Body of the draft, in HTML.
is_special optional boolean	If this post should be sent as a special message (only applies to moderators/owners).
bcc_me optional boolean	If the sender should be BCC'ed when this draft is posted (only applies to draft_type_reply)
bcc_all optional boolean	If all moderators should be BCC'ed when this draft is posted (only applies to draft_type_post_to_sub).

Returns

Returns the draft object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid draft_id" is returned if the draft id is missing or invalid.

POST /api/v1/updatedraft

$ curl "https://groups.io/api/v1/updatedraft" \
-b "cookies.curl" \
-d draft_id=12&csrf=12345

Example Successful Response:View Draft definition

 {
 "id": 0,
 "object": "draft",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 56,
 "group_id": 29,
 "draft_type": "",
 "subject": "",
 "body": "",
 "body_type": "",
 "is_special": false,
 "num_attachments": 92,
 "next_attachment_id": 31,
 "message_id": 77,
 "bcc_me": false,
 "bcc_all": false,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Drafts#

Get drafts. Drafts are returned using the pagination request and object format.

Permissions Needed

None

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are `created` or `subject`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns a draft list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/getdrafts

$ curl "https://groups.io/api/v1/getdrafts" \
-b "cookies.curl"

Example Successful Response:View Draft List definition

 {
 "object": "list",
 "total_count": 86,
 "start_item": 20,
 "end_item": 99,
 "has_more": false,
 "next_page_token": 62,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 47,
    "object": "draft",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 92,
    "group_id": 88,
    "draft_type": "",
    "subject": "",
    "body": "",
    "body_type": "",
    "is_special": false,
    "num_attachments": 11,
    "next_attachment_id": 3,
    "message_id": 88,
    "bcc_me": false,
    "bcc_all": false,
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Draft#

Delete a draft object.

Permissions Needed

You must be the owner of the draft.

POST Parameters

draft_id required integer	ID of the draft to delete. You must be the owner of the draft.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"invalid draft_id" is returned if the draft id is missing or invalid.

POST /api/v1/deletedraft

$ curl "https://groups.io/api/v1/deletedraft" \
-b "cookies.curl" \
-d draft_id=12&csrf=12345

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Upload Attachments#

Upload attachments as part of a draft.

Permissions Needed

You must be the owner of the draft.

POST Parameters

draft_id required integer	ID of the draft to associate the attachment to. You must be the owner of the draft.
fileupload required multipart file	Multipart file upload of one or more attachments.
csrf required string	The `csrf_token` from the user object returned when first logged in.
inline optional boolean	If the attachments are inline images.

Returns

Returns a draft attachment list object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid draft_id" is returned if the draft id is missing or invalid.

POST /api/v1/uploadattachments

$ curl "https://groups.io/api/v1/uploadattachments" \
-b "cookies.curl"
-F fileupload=@path_to_file \
-F "draft_id=12" \
-F "csrf=12345"

Example Successful Response:View Draft Attachment List definition

 {
 "object": "list",
 "total_count": 18,
 "start_item": 56,
 "end_item": 19,
 "has_more": false,
 "next_page_token": 7,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 57,
    "object": "draft_attachment",
    "draft_id": 52,
    "url": "",
    "filename": "",
    "size": 75,
    "content_type": "",
    "inline": false,
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Attachments#

Get attachments.

Permissions Needed

You must be the owner of the draft.

POST Parameters

draft_id required integer	ID of the draft containing the attachments. You must be the owner of the draft.

Returns

Returns a draft attachment list object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid draft_id" is returned if the draft id is missing or invalid.

GET /api/v1/getattachments

$ curl "https://groups.io/api/v1/getattachments?draft_id=12" \
-b "cookies.curl"

Example Successful Response:View Draft Attachment List definition

 {
 "object": "list",
 "total_count": 81,
 "start_item": 53,
 "end_item": 95,
 "has_more": false,
 "next_page_token": 17,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 93,
    "object": "draft_attachment",
    "draft_id": 70,
    "url": "",
    "filename": "",
    "size": 96,
    "content_type": "",
    "inline": false,
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Attachment#

Delete an attachment.

Permissions Needed

You must be the owner of the draft and attachment.

POST Parameters

draft_id required integer	ID of the draft containing the attachment to delete. You must be the owner of the draft.
attachment_id required integer	Attachment ID to delete.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"invalid draft_id" is returned if the draft id is missing or invalid.
"bad_request"	"invalid attachment_id" is returned if the attachment ID is missing or invalid.

POST /api/v1/deleteattachment

$ curl "https://groups.io/api/v1/deleteattachment" \
-b "cookies.curl" \
-d draft_id=12&csrf=12345

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Post Draft#

Post Draft.

Permissions Needed

You must be the owner of the draft. You must have the can_post permission in the group.

POST Parameters

draft_id required integer	ID of the draft to post. You must be the owner of the draft.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a success object on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Success Responses

"pending post"	Returned if the post requires approval before it is sent to the group.

Additional Errors

"bad_request"	"invalid draft_id" is returned if the draft id is missing or invalid.
"bad_request"	"no subject" is returned if the draft is missing a subject.
"bad_request"	"no body" is returned if the draft is missing a body.
"bad_request"	"need hashtag" is returned if the subject needs a hashtag.
"bad_request"	"restricted hashtag" is returned if the subject contains a hashtag that the user does not have permission to use.
"bad_request"	"mod only hashtag" is returned if the subject contains a hashtag that only moderators/owners can use.
"bad_request"	"private message" is returned if the subject starts with "Private:".
"bad_request"	"post too big" is returned if the body is too large to send.
"bad_request"	"announcement group" is returned if the group is an announcement group and the sender is not a moderator/owner.
"bad_request"	"bad attachment" is returned if the message contains an attachment that isn't allowed.
"bad_request"	"not subscribed" is returned if the user is not subscribed to the group.

POST /api/v1/postdraft

$ curl "https://groups.io/api/v1/postdraft" \
-b "cookies.curl" \
-d draft_id=12&csrf=12345

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Events

With RSVPs, here is the flow:

When viewing an event, if the rsvp field of the Event object is true, an RSVP is requested.
If the comment_label field in the Event is not empty, display a text field for entry of a comment.
If the additional_guests field of the Event object is true, display a drop down to select the number of additional guests.
If the has_rsvp field of the Event object is false, display three buttons: Will Attend, Will Not Attend, Not Sure.
If the has_rsvp field of the Event object is true, the rsvp_type, rsvp_comment and rsvp_additional_guests fields represent the previous RSVP response.
If the rsvp_type is rsvp_waitlist, that means the person is waitlisted. In this case, the Will Attend button should be 'Update Waitlisted'. This button should return a response value of rsvp_yes, not rsvp_waitlist.
On successfully calling the /v1/rsvp endpoint, an rsvp object is returned. If the type field is set to rsvp_waitlist, that means the user has been waitlisted, and a message should be shown to them announcing that.

Get Event#

Get a single event.

Permissions Needed

You must be subscribed to the group associated with the event.

Query Parameters

event_id required integer	The ID of the event to return.

Returns

Returns the event object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid event_id" is returned if the event id is missing or invalid.
"bad_request"	"not subscribed to group" is returned if the event belongs to a group the user is not a member of.

GET /api/v1/getevent

$ curl "https://groups.io/api/v1/getevent?event_id=12" \
-b "cookies.curl"

Example Successful Response:View Event definition

 {
 "id": 86,
 "object": "event",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "creator_name": "@JohnSmith",
 "group_id": 32,
 "group_name": "",
 "nice_group_name": "",
 "start_time": "2009-11-10T15:00:00-08:00",
 "end_time": "2009-11-10T15:00:00-08:00",
 "timezone": "",
 "all_day": false,
 "name": "",
 "location": "",
 "description": "",
 "organizer_name": "",
 "organizer_email": "",
 "organizer_phone": "",
 "color_name": "tag_antique_pink",
 "color_hex": "",
 "rsvp": false,
 "max_attendees": 20,
 "additional_guests": false,
 "comment_label": "",
 "yes_message": "",
 "has_rsvp": false,
 "rsvp_type": "",
 "rsvp_comment": "",
 "rsvp_additional_guests": 60,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Events#

Get a set of events. If group_id or group_name are specified, only events from those groups are returned. If neither are specified, events from all the groups subscribed to by the logged in user are returned. Event objects are returned using the pagination request and object format.

Query Parameters

start required string	The earliest date to return events from. In the form YYYY-MM-DD.
end optional string	The latest date to return events from. In the form YYYY-MM-DD.
group_id optional integer	ID of the group. If neither `group_id` nor `group_name` are specified, events from all subscriptions are returned.
group_name optional string	Name of the group. If neither `group_id` nor `group_name` are specified, events from all subscriptions are returned.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response. You must also continue to specify the same `start` and `end` parameters.

GET /api/v1/getevents

$ curl "https://groups.io/api/v1/getevents?start=2019-06-19&limit=2" \
-b "cookies.curl"

Example Successful Response:View Event List definition

 {
 "object": "list",
 "total_count": 22,
 "start_item": 29,
 "end_item": 61,
 "has_more": false,
 "next_page_token": 60,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 20,
    "object": "event",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "creator_name": "@JohnSmith",
    "group_id": 79,
    "group_name": "",
    "nice_group_name": "",
    "start_time": "2009-11-10T15:00:00-08:00",
    "end_time": "2009-11-10T15:00:00-08:00",
    "timezone": "",
    "all_day": false,
    "name": "",
    "location": "",
    "description": "",
    "organizer_name": "",
    "organizer_email": "",
    "organizer_phone": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "rsvp": false,
    "max_attendees": 54,
    "additional_guests": false,
    "comment_label": "",
    "yes_message": "",
    "has_rsvp": false,
    "rsvp_type": "",
    "rsvp_comment": "",
    "rsvp_additional_guests": 64,
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

RSVP To An Event#

RSVP to an event.

Permissions Needed

You must be subscribed to the group.

POST Parameters

event_id required integer	ID of the event to RSVP to. You must be subscribed to the group.
response required string	Can be one of: `rsvp_maybe`, `rsvp_no`, `rsvp_yes`.
additional_guests required number
comment required string
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns the rsvp object. Returns an error if parameters are invalid (e.g. specifying an invalid event_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid event_id" is returned if the event id is missing or invalid.
"bad_request"	"locked event" is returned if the event has been locked.
"bad_request"	"not subscribed" is returned if the user is not subscribed to the group.
"bad_request"	"waitlist response" is returned if the response field is `rsvp_waitlist`.

Notes

rsvp_waitlist is not a valid value for response. The user should only be given the options of Yes, No, or Maybe.
If the response is rsvp_yes, check the type field of the returned RSVP object. If it is rsvp_waitlist, the person has been waitlisted.

POST /api/v1/rsvp

$ curl "https://groups.io/api/v1/rsvp" \
-b "cookies.curl" \
-d event_id=12&response=rsvp_yes&csrf=12345

Example Successful Response:View RSVP definition

 {
 "id": 60,
 "object": "rsvp",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "event_id": 51,
 "group_id": 81,
 "user_id": 57,
 "user_name": "",
 "full_name": "",
 "email": "",
 "profile_photo_url": "",
 "type": "rsvp_maybe",
 "comment": "",
 "additional_guests": 16,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Feed

Get Feed#

Get the list of feeds associated with the logged in user. Feed objects are returned using the pagination request and object format.

Query Parameters

GET /api/v1/feed

$ curl "https://groups.io/api/v1/getfeed?limit=2&page_token=1" \
-b "cookies.curl"

Example Successful Response:View Feed List definition

 {
 "object": "list",
 "total_count": 0,
 "start_item": 39,
 "end_item": 37,
 "has_more": false,
 "next_page_token": 33,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "feed",
    "member_info": 
      {
       "id": 61,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 4,
       "group_id": 85,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 9,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 15,
       "pending_subs": 19,
       "pending_msgs": 14,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      },
    "group": 
      {
       "id": 40,
       "object": "group",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "title": "The Example Group",
       "name": "example",
       "nice_group_name": "",
       "alias": "",
       "desc": "This is the description for the example group.",
       "plain_desc": "This is the description for the example group.",
       "subject_tag": "[example]",
       "footer": "",
       "website": "",
       "announce": false,
       "moderated": false,
       "new_users_moderated": false,
       "unmoderate_users_after": 62,
       "restricted": false,
       "allow_non_subs_to_post": false,
       "force_html_emails": false,
       "normalize_html_emails": false,
       "reply_to": "group_reply_only_to_sender",
       "remove_other_reply_options": false,
       "privacy": "group_privacy_archives",
       "seperate_footers": false,
       "allow_downloads": "allow_downloads_by_members",
       "members_visible": "group_view_members_moderators",
       "subgroup_access": "sub_group_moderators",
       "calendar_access": "group_access_limited",
       "files_access": "group_access_limited",
       "database_access": "group_access_limited",
       "wiki_access": "group_access_limited",
       "photos_access": "group_access_limited",
       "member_directory_access": "group_access_limited",
       "polls_access": "polls_access_limited",
       "chat_access": "group_access_limited",
       "handle_attachments": "group_attachments_bounced",
       "plain_text_only": false,
       "handle_virus": "handle_virus_block",
       "locked": false,
       "has_cover_photo": false,
       "has_icon": false,
       "parent_group_id": 40,
       "org_id": 0,
       "max_photo_size_email": "max_photo_size_ex_small",
       "max_photo_size_photos": "max_photo_size_ex_small",
       "max_photo_size_databases": "max_photo_size_ex_small",
       "max_photo_size_wiki_images": "max_photo_size_ex_small",
       "hash_tags_required": false,
       "hash_tag_permissions": "hash_tag_create_mods_bounce",
       "bounce_attachments": false,
       "allow_photos_in_files": false,
       "allow_reposts": false,
       "min_days_between_reposts": 84,
       "max_number_of_reposts": 73,
       "email_delivery_default": "email_delivery_digest",
       "message_selection_default": "message_selection_all",
       "auto_follow_replies_default": false,
       "max_attachment_size_default": "max_attachment_size_large",
       "default_timezone": "",
       "default_time_pref": "military_time",
       "default_date_pref": "international_date",
       "default_monday_start": false,
       "disable_edits": false,
       "disable_no_email": false,
       "auto_close_threads": false,
       "close_threads_after": 35,
       "auto_moderate_threads": false,
       "moderate_threads_after": 43,
       "subgroupcategoryid": 21,
       "subs_count": 90,
       "pending_subs_count": 74,
       "pending_msgs_count": 69,
       "open_chats_count": 70,
       "threads_count": 36,
       "messages_count": 38,
       "org_domain": "",
       "most_recent_message": "2009-11-10T15:00:00-08:00",
       "cover_photo_url": "",
       "icon_url": "",
       "group_url": "",
       "allow_parent_subs_to_post": false,
       "send_event_summaries": false,
       "event_summary_schedule": "event_summary_monthly",
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      },
    "topics": [
      {
       "topic": 
         {
          "id": 72,
          "object": "topic",
          "created": "2009-11-10T15:00:00-08:00",
          "updated": "2009-11-10T15:00:00-08:00",
          "group_id": 44,
          "group_subject_tag": "",
          "subject": "",
          "summary": "",
          "name": "",
          "profile_photo_url": "",
          "num_messages": 95,
          "is_sticky": false,
          "is_moderated": false,
          "is_closed": false,
          "has_attachments": false,
          "reply_to": "thread_reply_group_default",
          "most_recent_message": "2009-11-10T15:00:00-08:00",
          "hashtags": [
            {
             "id": 74,
             "object": "hashtag",
             "created": "2009-11-10T15:00:00-08:00",
             "group_id": 37,
             "name": "",
             "alias": 
               {
               },
             "mods_only_post": false,
             "mods_only_replies": false,
             "no_email": false,
             "moderated": false,
             "special": false,
             "replies_unmoderated": false,
             "locked": false,
             "until": "hash_tag_delete_day",
             "close_instead_of_delete": false,
             "description": "",
             "color_name": "tag_antique_pink",
             "color_hex": "",
             "reply_to": "thread_reply_group_default",
             "topic_count": 24,
             "last_message_date": "2009-11-10T15:00:00-08:00",
            }
          ],
         },
       "images": [
         {
          "id": "",
          "object": "attachment",
          "created": "2009-11-10T15:00:00-08:00",
          "group_id": 93,
          "user_id": 6,
          "thread_id": 48,
          "message_num": 52,
          "attach_num": 20,
          "type": "",
          "sub_type": "",
          "name": "",
          "content": "",
          "image_width": 22,
          "image_height": 71,
          "thumbnail_url": "",
         }
       ],
      }
    ],
    "events": [
      {
       "id": 17,
       "object": "event",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "creator_name": "@JohnSmith",
       "group_id": 51,
       "group_name": "",
       "nice_group_name": "",
       "start_time": "2009-11-10T15:00:00-08:00",
       "end_time": "2009-11-10T15:00:00-08:00",
       "timezone": "",
       "all_day": false,
       "name": "",
       "location": "",
       "description": "",
       "organizer_name": "",
       "organizer_email": "",
       "organizer_phone": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "rsvp": false,
       "max_attendees": 65,
       "additional_guests": false,
       "comment_label": "",
       "yes_message": "",
       "has_rsvp": false,
       "rsvp_type": "",
       "rsvp_comment": "",
       "rsvp_additional_guests": 82,
      }
    ],
    "files": [
      {
       "id": 79,
       "object": "file",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 92,
       "group_id": 29,
       "name": "",
       "desc": "",
       "size": 31,
       "path": "",
       "parent_folder_id": 21,
       "is_folder": false,
       "count": 55,
       "media_type": "",
       "download_url": "",
       "display_name": "",
       "user_name": "",
       "profile_photo_url": "",
       "profile_privacy": "",
       "email": "",
      }
    ],
    "photos": [
      {
       "id": 11,
       "object": "photo",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 43,
       "group_id": 53,
       "name": "",
       "desc": "",
       "media_type": "image/jpeg",
       "size": 66,
       "attachment_num": 59,
       "width": 67,
       "height": 8,
       "album_id": 8,
       "display_name": "",
       "user_name": "",
       "profile_photo_url": "",
       "profile_privacy": "",
       "email": "",
       "format": "gif",
       "focal_length": 3.2,
       "iso": 28,
       "aperture": 3.2,
       "shutter_speed": 53,
       "taken": 74,
       "make": "",
       "model": "",
       "thumbnail_url": "",
       "download_url": "",
      }
    ],
    "chats": [
      {
       "id": 84,
       "object": "chat",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 75,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 74,
       "subject": "The chat subject",
       "desc": "This is the description of the chat",
       "is_closed": false,
       "num_messages": 6,
       "chat_sub": 
         {
          "id": 37,
          "object": "chat_sub",
          "created": "2009-11-10T15:00:00-08:00",
          "updated": "2009-11-10T15:00:00-08:00",
          "user_id": 86,
          "group_id": 67,
          "chat_id": 14,
          "last_msg_seen": 58,
         },
      }
    ],
    "wikis": [
      {
       "id": 59,
       "object": "wiki_page",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 46,
       "group_id": 23,
       "title": "",
       "path": "",
       "locked": false,
       "rev_count": 24,
      }
    ],
    "subgroups": [
      {
       "id": 87,
       "object": "group",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "title": "The Example Group",
       "name": "example",
       "nice_group_name": "",
       "alias": "",
       "desc": "This is the description for the example group.",
       "plain_desc": "This is the description for the example group.",
       "subject_tag": "[example]",
       "footer": "",
       "website": "",
       "announce": false,
       "moderated": false,
       "new_users_moderated": false,
       "unmoderate_users_after": 57,
       "restricted": false,
       "allow_non_subs_to_post": false,
       "force_html_emails": false,
       "normalize_html_emails": false,
       "reply_to": "group_reply_only_to_sender",
       "remove_other_reply_options": false,
       "privacy": "group_privacy_archives",
       "seperate_footers": false,
       "allow_downloads": "allow_downloads_by_members",
       "members_visible": "group_view_members_moderators",
       "subgroup_access": "sub_group_moderators",
       "calendar_access": "group_access_limited",
       "files_access": "group_access_limited",
       "database_access": "group_access_limited",
       "wiki_access": "group_access_limited",
       "photos_access": "group_access_limited",
       "member_directory_access": "group_access_limited",
       "polls_access": "polls_access_limited",
       "chat_access": "group_access_limited",
       "handle_attachments": "group_attachments_bounced",
       "plain_text_only": false,
       "handle_virus": "handle_virus_block",
       "locked": false,
       "has_cover_photo": false,
       "has_icon": false,
       "parent_group_id": 74,
       "org_id": 39,
       "max_photo_size_email": "max_photo_size_ex_small",
       "max_photo_size_photos": "max_photo_size_ex_small",
       "max_photo_size_databases": "max_photo_size_ex_small",
       "max_photo_size_wiki_images": "max_photo_size_ex_small",
       "hash_tags_required": false,
       "hash_tag_permissions": "hash_tag_create_mods_bounce",
       "bounce_attachments": false,
       "allow_photos_in_files": false,
       "allow_reposts": false,
       "min_days_between_reposts": 31,
       "max_number_of_reposts": 46,
       "email_delivery_default": "email_delivery_digest",
       "message_selection_default": "message_selection_all",
       "auto_follow_replies_default": false,
       "max_attachment_size_default": "max_attachment_size_large",
       "default_timezone": "",
       "default_time_pref": "military_time",
       "default_date_pref": "international_date",
       "default_monday_start": false,
       "disable_edits": false,
       "disable_no_email": false,
       "auto_close_threads": false,
       "close_threads_after": 83,
       "auto_moderate_threads": false,
       "moderate_threads_after": 28,
       "subgroupcategoryid": 16,
       "subs_count": 26,
       "pending_subs_count": 77,
       "pending_msgs_count": 12,
       "open_chats_count": 36,
       "threads_count": 51,
       "messages_count": 5,
       "org_domain": "",
       "most_recent_message": "2009-11-10T15:00:00-08:00",
       "cover_photo_url": "",
       "icon_url": "",
       "group_url": "",
       "allow_parent_subs_to_post": false,
       "send_event_summaries": false,
       "event_summary_schedule": "event_summary_monthly",
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      }
    ],
    "tables": [
      {
       "id": 62,
       "object": "databasetable",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "group_id": 89,
       "user_id": 98,
       "name": "",
       "short_desc": "",
       "desc": "",
       "desc_type": "",
       "edit_table": "",
       "edit_rows": "",
       "add_rows": "",
       "view_table": "",
       "num_rows": 87,
       "max_row_id": 30,
       "num_columns": 9,
       "max_col_id": 28,
       "display_template": "",
       "columns": [
         {
          "id": 59,
          "name": "",
          "type": "",
          "required": false,
          "color": "",
          "choices": [""],
          "width": 61,
         }
       ],
      }
    ],
    "hashtags": [
      {
       "id": 2,
       "object": "hashtag",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 18,
       "name": "",
       "alias": 
         {
         },
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": false,
       "replies_unmoderated": false,
       "locked": false,
       "until": "hash_tag_delete_day",
       "close_instead_of_delete": false,
       "description": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "reply_to": "thread_reply_group_default",
       "topic_count": 45,
       "last_message_date": "2009-11-10T15:00:00-08:00",
      }
    ],
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Files

These are the API endpoints for directories and files.

Get File Directory#

Get file directory. Files and directories are returned using the pagination request and object format.

Permissions Needed

You must have the view_files permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
path optional string	Path to view. Path can either be empty or a folder.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are: `title`, `created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns a file list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/getfiledirectory

$ curl "https://groups.io/api/v1/getfiledirectory?group_id=12&path=%2FTop%2FNext" \
-b "cookies.curl"

Example Successful Response:View File List definition

 {
 "object": "list",
 "total_count": 71,
 "start_item": 53,
 "end_item": 40,
 "has_more": false,
 "next_page_token": 20,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "path": "",
 "files_percentage": 81,
 "files_gigs": "",
 "data": [
   {
    "id": 5,
    "object": "file",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 76,
    "group_id": 9,
    "name": "",
    "desc": "",
    "size": 66,
    "path": "",
    "parent_folder_id": 56,
    "is_folder": false,
    "count": 95,
    "media_type": "",
    "download_url": "",
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get File#

Get file.

Permissions Needed

You must have the view_files permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
path required string	Path to file to download.

Returns

Returns a file object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/getfile

$ curl "https://groups.io/api/v1/getfile?group_id=12" \
-b "cookies.curl"

Example Successful Response:View File definition

 {
 "id": 80,
 "object": "file",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 34,
 "group_id": 77,
 "name": "",
 "desc": "",
 "size": 67,
 "path": "",
 "parent_folder_id": 78,
 "is_folder": false,
 "count": 75,
 "media_type": "",
 "download_url": "",
 "display_name": "",
 "user_name": "",
 "profile_photo_url": "",
 "profile_privacy": "",
 "email": "",
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Search Files#

Search files. Files and directory matches are returned using the pagination request and object format.

Permissions Needed

You must have the view_files permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
q required string	Query string.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are: `title`, `created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns a file list object if successful. Returns an error if there is an error.

Additional Errors

"bad_request"	"invalid query" is returned if the query string is empty.

GET /api/v1/searchfiles

$ curl "https://groups.io/api/v1/searchfiles?group_id=12&q=Search+Term" \
-b "cookies.curl"

Example Successful Response:View File List definition

 {
 "object": "list",
 "total_count": 93,
 "start_item": 80,
 "end_item": 8,
 "has_more": false,
 "next_page_token": 31,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "path": "",
 "files_percentage": 65,
 "files_gigs": "",
 "data": [
   {
    "id": 58,
    "object": "file",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 84,
    "group_id": 42,
    "name": "",
    "desc": "",
    "size": 23,
    "path": "",
    "parent_folder_id": 62,
    "is_folder": false,
    "count": 73,
    "media_type": "",
    "download_url": "",
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Add Files#

Add files. IN DEVELOPMENT. DO NOT USE YET.

Permissions Needed

You must have permission to add files to the folder.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
folder_id required integer	ID of the folder to add the files to, or 0 if the top-level.
desc optional string	Description of the file.
fileupload required multipart file	Multipart file upload of one or more files.
is_folder optional boolean	If `true`, this is an upload of a folder. We will interpret filenames as full paths, using either `/` or `\` as a separator. We will create folders as needed.
notify optional boolean	If `true`, send a notification to the group.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a file list object if successful. Returns an error if there is an error.

Additional Errors

"bad_request"	"invalid folder_id" is returned if the folder id is missing or invalid.

POST /api/v1/addfiles

$ curl "https://groups.io/api/v1/addfiles" \
-b "cookies.curl"
-F fileupload=@path_to_file \
-F "folder_id=12" \
-F "csrf=12345"

Example Successful Response:View File List definition

 {
 "object": "list",
 "total_count": 72,
 "start_item": 53,
 "end_item": 58,
 "has_more": false,
 "next_page_token": 27,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "path": "",
 "files_percentage": 96,
 "files_gigs": "",
 "data": [
   {
    "id": 48,
    "object": "file",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 13,
    "group_id": 31,
    "name": "",
    "desc": "",
    "size": 74,
    "path": "",
    "parent_folder_id": 6,
    "is_folder": false,
    "count": 40,
    "media_type": "",
    "download_url": "",
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Group

Create Group#

Create a group.

Permissions Needed

None.

POST Parameters

group_name required string	Name of the new group.
desc required string	Description of the new group.
privacy required string	Privacy of the new group, one of `group_privacy_none`, `group_privacy_archives`, `group_privacy_unlisted`, `group_privacy_unlisted_public`
sub_group_access required string	Who can create subgroups, one of `sub_group_subs`, `sub_group_moderators`, `sub_group_owners`
csrf required string	The `csrf_token` from the user object returned when first logged in.
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`

Returns

Returns the group object if the group is successfully created. Returns an error if parameters are invalid (e.g. specifying an invalid group_name). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_name" is returned if the group name is not a valid group name.
"bad_request"	"description too short" is returned if the group description is too short.
"bad_request"	"name already taken" is returned if a group with that name already exists.

Notes

A subscription is created for the user to the group with owner permissions. If email_delivery, message_selection, auto_follow_replies, or max_attachment_size is specified, the subscription will be created with those values.

POST /api/v1/creategroup

$ curl "https://groups.io/api/v1/creategroup" \
-b "cookies.curl" \
-d group_name=apisubgroup \
-d desc=This+is+my+group \
-d privacy=group_privacy_none \
-d csrf=12345

Example Successful Response:View Group definition

 {
 "id": 31,
 "object": "group",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "title": "The Example Group",
 "name": "example",
 "nice_group_name": "",
 "alias": "",
 "desc": "This is the description for the example group.",
 "plain_desc": "This is the description for the example group.",
 "subject_tag": "[example]",
 "footer": "",
 "website": "",
 "announce": false,
 "moderated": false,
 "new_users_moderated": false,
 "unmoderate_users_after": 32,
 "restricted": false,
 "allow_non_subs_to_post": false,
 "force_html_emails": false,
 "normalize_html_emails": false,
 "reply_to": "group_reply_only_to_sender",
 "remove_other_reply_options": false,
 "privacy": "group_privacy_archives",
 "seperate_footers": false,
 "allow_downloads": "allow_downloads_by_members",
 "members_visible": "group_view_members_moderators",
 "subgroup_access": "sub_group_moderators",
 "calendar_access": "group_access_limited",
 "files_access": "group_access_limited",
 "database_access": "group_access_limited",
 "wiki_access": "group_access_limited",
 "photos_access": "group_access_limited",
 "member_directory_access": "group_access_limited",
 "polls_access": "polls_access_limited",
 "chat_access": "group_access_limited",
 "handle_attachments": "group_attachments_bounced",
 "plain_text_only": false,
 "handle_virus": "handle_virus_block",
 "locked": false,
 "has_cover_photo": false,
 "has_icon": false,
 "parent_group_id": 77,
 "org_id": 2,
 "max_photo_size_email": "max_photo_size_ex_small",
 "max_photo_size_photos": "max_photo_size_ex_small",
 "max_photo_size_databases": "max_photo_size_ex_small",
 "max_photo_size_wiki_images": "max_photo_size_ex_small",
 "hash_tags_required": false,
 "hash_tag_permissions": "hash_tag_create_mods_bounce",
 "bounce_attachments": false,
 "allow_photos_in_files": false,
 "allow_reposts": false,
 "min_days_between_reposts": 54,
 "max_number_of_reposts": 83,
 "email_delivery_default": "email_delivery_digest",
 "message_selection_default": "message_selection_all",
 "auto_follow_replies_default": false,
 "max_attachment_size_default": "max_attachment_size_large",
 "default_timezone": "",
 "default_time_pref": "military_time",
 "default_date_pref": "international_date",
 "default_monday_start": false,
 "disable_edits": false,
 "disable_no_email": false,
 "auto_close_threads": false,
 "close_threads_after": 30,
 "auto_moderate_threads": false,
 "moderate_threads_after": 86,
 "subgroupcategoryid": 87,
 "subs_count": 62,
 "pending_subs_count": 4,
 "pending_msgs_count": 21,
 "open_chats_count": 93,
 "threads_count": 98,
 "messages_count": 56,
 "org_domain": "",
 "most_recent_message": "2009-11-10T15:00:00-08:00",
 "cover_photo_url": "",
 "icon_url": "",
 "group_url": "",
 "allow_parent_subs_to_post": false,
 "send_event_summaries": false,
 "event_summary_schedule": "event_summary_monthly",
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Create Sub Group#

Create a subgroup.

Permissions Needed

You must have the manage_subgroups permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
sub_group_name required string	Name of the new subgroup
desc required string	Description of the new subgroup
privacy required string	Privacy of the new subgroup, one of `sub_group_privacy_limited_archives`, `sub_group_privacy_archives`, `sub_group_privacy_unlisted`, `sub_group_privacy_none`
csrf required string	The `csrf_token` from the user object returned when first logged in.
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`

Returns

Returns the group object if the subgroup is successfully created. Returns an error if parameters are invalid (e.g. specifying an invalid sub_group_name). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_name" is returned if the group name is not a valid group nae.
"bad_request"	"description too short" is returned if the subgroup description is too short.
"bad_request"	"name already taken" is returned if a subgroup with that name already exists.
"bad_request"	"group is a subgroup" is returned if the `group_id` refers to a subgroup and not a parent group.

Notes

A subscription is created for the user to the group with owner permissions. If email_delivery, message_selection, auto_follow_replies, or max_attachment_size is specified, the subscription will be created with those values.

POST /api/v1/createsubgroup

$ curl "https://groups.io/api/v1/createsubgroup" \
-b "cookies.curl" \
-d group_id=5 \
-d sub_group_name=apisubgroup \
-d desc=This+is+my+subgroup \
-d privacy=sub_group_privacy_none \
-d csrf=12345

Example Successful Response:View Group definition

 {
 "id": 65,
 "object": "group",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "title": "The Example Group",
 "name": "example",
 "nice_group_name": "",
 "alias": "",
 "desc": "This is the description for the example group.",
 "plain_desc": "This is the description for the example group.",
 "subject_tag": "[example]",
 "footer": "",
 "website": "",
 "announce": false,
 "moderated": false,
 "new_users_moderated": false,
 "unmoderate_users_after": 22,
 "restricted": false,
 "allow_non_subs_to_post": false,
 "force_html_emails": false,
 "normalize_html_emails": false,
 "reply_to": "group_reply_only_to_sender",
 "remove_other_reply_options": false,
 "privacy": "group_privacy_archives",
 "seperate_footers": false,
 "allow_downloads": "allow_downloads_by_members",
 "members_visible": "group_view_members_moderators",
 "subgroup_access": "sub_group_moderators",
 "calendar_access": "group_access_limited",
 "files_access": "group_access_limited",
 "database_access": "group_access_limited",
 "wiki_access": "group_access_limited",
 "photos_access": "group_access_limited",
 "member_directory_access": "group_access_limited",
 "polls_access": "polls_access_limited",
 "chat_access": "group_access_limited",
 "handle_attachments": "group_attachments_bounced",
 "plain_text_only": false,
 "handle_virus": "handle_virus_block",
 "locked": false,
 "has_cover_photo": false,
 "has_icon": false,
 "parent_group_id": 45,
 "org_id": 94,
 "max_photo_size_email": "max_photo_size_ex_small",
 "max_photo_size_photos": "max_photo_size_ex_small",
 "max_photo_size_databases": "max_photo_size_ex_small",
 "max_photo_size_wiki_images": "max_photo_size_ex_small",
 "hash_tags_required": false,
 "hash_tag_permissions": "hash_tag_create_mods_bounce",
 "bounce_attachments": false,
 "allow_photos_in_files": false,
 "allow_reposts": false,
 "min_days_between_reposts": 6,
 "max_number_of_reposts": 99,
 "email_delivery_default": "email_delivery_digest",
 "message_selection_default": "message_selection_all",
 "auto_follow_replies_default": false,
 "max_attachment_size_default": "max_attachment_size_large",
 "default_timezone": "",
 "default_time_pref": "military_time",
 "default_date_pref": "international_date",
 "default_monday_start": false,
 "disable_edits": false,
 "disable_no_email": false,
 "auto_close_threads": false,
 "close_threads_after": 24,
 "auto_moderate_threads": false,
 "moderate_threads_after": 20,
 "subgroupcategoryid": 44,
 "subs_count": 59,
 "pending_subs_count": 7,
 "pending_msgs_count": 24,
 "open_chats_count": 57,
 "threads_count": 53,
 "messages_count": 74,
 "org_domain": "",
 "most_recent_message": "2009-11-10T15:00:00-08:00",
 "cover_photo_url": "",
 "icon_url": "",
 "group_url": "",
 "allow_parent_subs_to_post": false,
 "send_event_summaries": false,
 "event_summary_schedule": "event_summary_monthly",
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Group Settings#

Get the group settings

Permissions Needed

No permissions are needed, but some fields will not be returned if you do not have the proper permissions. For security reasons, you must specify a group_name to access information about a group that you are not subscribed to.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified, but `group_id` will be ignored if you are not subscribed to the group.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified, but `group_id` will be ignored if you are not subscribed to the group.

GET /api/v1/getgroup

$ curl "https://groups.io/api/v1/getgroup?group_id=7" \
-b "cookies.curl"

Example Successful Response:View Group definition

 {
 "id": 75,
 "object": "group",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "title": "The Example Group",
 "name": "example",
 "nice_group_name": "",
 "alias": "",
 "desc": "This is the description for the example group.",
 "plain_desc": "This is the description for the example group.",
 "subject_tag": "[example]",
 "footer": "",
 "website": "",
 "announce": false,
 "moderated": false,
 "new_users_moderated": false,
 "unmoderate_users_after": 40,
 "restricted": false,
 "allow_non_subs_to_post": false,
 "force_html_emails": false,
 "normalize_html_emails": false,
 "reply_to": "group_reply_only_to_sender",
 "remove_other_reply_options": false,
 "privacy": "group_privacy_archives",
 "seperate_footers": false,
 "allow_downloads": "allow_downloads_by_members",
 "members_visible": "group_view_members_moderators",
 "subgroup_access": "sub_group_moderators",
 "calendar_access": "group_access_limited",
 "files_access": "group_access_limited",
 "database_access": "group_access_limited",
 "wiki_access": "group_access_limited",
 "photos_access": "group_access_limited",
 "member_directory_access": "group_access_limited",
 "polls_access": "polls_access_limited",
 "chat_access": "group_access_limited",
 "handle_attachments": "group_attachments_bounced",
 "plain_text_only": false,
 "handle_virus": "handle_virus_block",
 "locked": false,
 "has_cover_photo": false,
 "has_icon": false,
 "parent_group_id": 89,
 "org_id": 14,
 "max_photo_size_email": "max_photo_size_ex_small",
 "max_photo_size_photos": "max_photo_size_ex_small",
 "max_photo_size_databases": "max_photo_size_ex_small",
 "max_photo_size_wiki_images": "max_photo_size_ex_small",
 "hash_tags_required": false,
 "hash_tag_permissions": "hash_tag_create_mods_bounce",
 "bounce_attachments": false,
 "allow_photos_in_files": false,
 "allow_reposts": false,
 "min_days_between_reposts": 45,
 "max_number_of_reposts": 39,
 "email_delivery_default": "email_delivery_digest",
 "message_selection_default": "message_selection_all",
 "auto_follow_replies_default": false,
 "max_attachment_size_default": "max_attachment_size_large",
 "default_timezone": "",
 "default_time_pref": "military_time",
 "default_date_pref": "international_date",
 "default_monday_start": false,
 "disable_edits": false,
 "disable_no_email": false,
 "auto_close_threads": false,
 "close_threads_after": 81,
 "auto_moderate_threads": false,
 "moderate_threads_after": 31,
 "subgroupcategoryid": 51,
 "subs_count": 85,
 "pending_subs_count": 29,
 "pending_msgs_count": 3,
 "open_chats_count": 95,
 "threads_count": 92,
 "messages_count": 72,
 "org_domain": "",
 "most_recent_message": "2009-11-10T15:00:00-08:00",
 "cover_photo_url": "",
 "icon_url": "",
 "group_url": "",
 "allow_parent_subs_to_post": false,
 "send_event_summaries": false,
 "event_summary_schedule": "event_summary_monthly",
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Sub Groups#

Get a group's subgroups.

Permissions Needed

You must have the manage_group_settings permission to use this call.

Query Parameters

group_id required integer	ID of the parent group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the parent group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `created`, `name`.
sort_dir optional string	Sort direction. Can be `asc` or .

GET /api/v1/getsubgroups

$ curl "https://groups.io/api/v1/getsubgroups?group_id=5" \
-b "cookies.curl"

Example Successful Response:View Group List definition

 {
 "object": "list",
 "total_count": 75,
 "start_item": 77,
 "end_item": 62,
 "has_more": false,
 "next_page_token": 73,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 17,
    "object": "group",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "title": "The Example Group",
    "name": "example",
    "nice_group_name": "",
    "alias": "",
    "desc": "This is the description for the example group.",
    "plain_desc": "This is the description for the example group.",
    "subject_tag": "[example]",
    "footer": "",
    "website": "",
    "announce": false,
    "moderated": false,
    "new_users_moderated": false,
    "unmoderate_users_after": 59,
    "restricted": false,
    "allow_non_subs_to_post": false,
    "force_html_emails": false,
    "normalize_html_emails": false,
    "reply_to": "group_reply_only_to_sender",
    "remove_other_reply_options": false,
    "privacy": "group_privacy_archives",
    "seperate_footers": false,
    "allow_downloads": "allow_downloads_by_members",
    "members_visible": "group_view_members_moderators",
    "subgroup_access": "sub_group_moderators",
    "calendar_access": "group_access_limited",
    "files_access": "group_access_limited",
    "database_access": "group_access_limited",
    "wiki_access": "group_access_limited",
    "photos_access": "group_access_limited",
    "member_directory_access": "group_access_limited",
    "polls_access": "polls_access_limited",
    "chat_access": "group_access_limited",
    "handle_attachments": "group_attachments_bounced",
    "plain_text_only": false,
    "handle_virus": "handle_virus_block",
    "locked": false,
    "has_cover_photo": false,
    "has_icon": false,
    "parent_group_id": 7,
    "org_id": 80,
    "max_photo_size_email": "max_photo_size_ex_small",
    "max_photo_size_photos": "max_photo_size_ex_small",
    "max_photo_size_databases": "max_photo_size_ex_small",
    "max_photo_size_wiki_images": "max_photo_size_ex_small",
    "hash_tags_required": false,
    "hash_tag_permissions": "hash_tag_create_mods_bounce",
    "bounce_attachments": false,
    "allow_photos_in_files": false,
    "allow_reposts": false,
    "min_days_between_reposts": 5,
    "max_number_of_reposts": 6,
    "email_delivery_default": "email_delivery_digest",
    "message_selection_default": "message_selection_all",
    "auto_follow_replies_default": false,
    "max_attachment_size_default": "max_attachment_size_large",
    "default_timezone": "",
    "default_time_pref": "military_time",
    "default_date_pref": "international_date",
    "default_monday_start": false,
    "disable_edits": false,
    "disable_no_email": false,
    "auto_close_threads": false,
    "close_threads_after": 74,
    "auto_moderate_threads": false,
    "moderate_threads_after": 44,
    "subgroupcategoryid": 23,
    "subs_count": 94,
    "pending_subs_count": 22,
    "pending_msgs_count": 33,
    "open_chats_count": 74,
    "threads_count": 10,
    "messages_count": 30,
    "org_domain": "",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "cover_photo_url": "",
    "icon_url": "",
    "group_url": "",
    "allow_parent_subs_to_post": false,
    "send_event_summaries": false,
    "event_summary_schedule": "event_summary_monthly",
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Group Aliases#

Get a group's aliases.

Permissions Needed

You must have the manage_group_settings permission to use this call.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `created`, `name`.
sort_dir optional string	Sort direction. Can be `asc` or .

Notes

Aliases are only available for premium and enterprise groups.
The group that an alias points to is identified by the alias_group_id field in the Group Alias object returned.

GET /api/v1/getgroupaliases

$ curl "https://groups.io/api/v1/getgroupaliases?group_id=5" \
-b "cookies.curl"

Example Successful Response:View Group Alias List definition

 {
 "object": "list",
 "total_count": 95,
 "start_item": 14,
 "end_item": 23,
 "has_more": false,
 "next_page_token": 50,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 9,
    "object": "groupalias",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "name": "example",
    "alias_group_id": 77,
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Permissions#

Return which permissions you have in a group. Each subscription grants a set of permissions in a group. The permissions are determined by a whether a subscription is a normal user, a moderator, or an owner, as well as the various group settings. Note: you do not need to be subscribed to the group.

Permissions Needed

None.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.

GET /api/v1/getperms

$ curl "https://groups.io/api/v1/getperms?group_id=7" \
-b "cookies.curl"

Example Successful Response:View Perms definition

 {
 "object": "perms",
 "manage_subgroups": false,
 "delete_group": false,
 "download_archives": false,
 "download_entire_group": false,
 "download_members": false,
 "view_activity": false,
 "manage_hashtags": false,
 "manage_integrations": false,
 "manage_group_settings": false,
 "make_moderator": false,
 "manage_member_subscription_options": false,
 "manage_pending_members": false,
 "remove_members": false,
 "ban_members": false,
 "manage_group_billing": false,
 "manage_group_payments": false,
 "edit_archives": false,
 "manage_pending_messages": false,
 "invite_members": false,
 "view_databases": false,
 "can_post": false,
 "can_vote": false,
 "manage_polls": false,
 "view_photos": false,
 "manage_photos": false,
 "manage_members": false,
 "view_calendar": false,
 "manage_calendar": false,
 "view_chats": false,
 "manage_chats": false,
 "view_member_directory": false,
 "view_files": false,
 "manage_files": false,
 "view_members": false,
 "view_wiki": false,
 "manage_wiki": false,
 "manage_subscription": false,
 "public_page": false,
 "sub_page": false,
 "mod_page": false,
 "archives_visible": false,
 "members_visible": false,
 "chat_visible": false,
 "calendar_visible": false,
 "files_visible": false,
 "database_visible": false,
 "photos_visible": false,
 "wiki_visible": false,
 "member_directory_visible": false,
 "hashtags_visible": false,
 "guidelines_visible": false,
 "subgroups_visible": false,
 "open_donations_visible": false,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Group#

Update a group's settings.

Permissions Needed

You must have the manage_group_settings permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf required string	The `csrf_token` from the user object returned when first logged in.
title optional string	Title.
name optional string	Name.
alias optional string	Alias.
desc optional string	Description.
subject_tag optional string	Subject tag.
footer optional string	Message footer.
website optional string	Website.
announce optional boolean
moderated optional boolean
new_users_moderated optional boolean
unmoderate_users_after optional number
restricted optional boolean
allow_non_subs_to_post optional boolean
force_html_emails optional boolean
normalize_html_emails optional boolean
reply_to optional string	Can be `group_reply_to_group`, `group_reply_to_sender`, `group_reply_to_moderators`, `group_reply_to_group_and_sender`
remove_other_reply_options optional boolean
privacy optional string	For a parent/stand alone group, can be `group_privacy_none`, `group_privacy_archives`, `group_privacy_unlisted`, `group_privacy_unlisted_public`. For a subgroup, can be `sub_group_privacy_limited_archives`, `sub_group_privacy_archives`, `sub_group_privacy_unlisted`, `sub_group_privacy_none`, `sub_group_privacy_unlisted_public_archives`.
members_visible optional string	Can be `group_view_members_subs`, `group_view_members_moderators`, `group_view_members_owners`
subgroup_access optional string	Can be `sub_group_subs`, `sub_group_moderators`, `sub_group_owners`
calendar_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`
files_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`
database_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`
wiki_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`
photos_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`
member_directory_access optional string	Can be `group_access_limited`, `group_access_moderators_only`, `group_access_none`
polls_access optional string	Can be `polls_access_subscribers`, `polls_access_limited`, `polls_access_none`
chat_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_none`
handle_attachments optional string	Can be `group_attachments_normal`, `group_attachments_bounced`, `group_attachments_stripped`, `group_attachments_moderated`
handle_virus optional string	Can be: `handle_virus_block`, `handle_virus_moderate`
plain_text_only optional boolean
fig_leaf optional string	Can be `fig_leaf_archives`, `fig_leaf_none`
max_photo_size_email optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
max_photo_size_photos optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
max_photo_size_databases optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
max_photo_size_wiki_images optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
hash_tags_required optional boolean
hash_tag_permissions optional string	Can be: `hash_tag_create_subs`, `hash_tag_create_mods_bounce`, `hash_tag_create_mods_remove`
bounce_attachments optional boolean
allow_photos_in_files optional boolean
email_delivery_default optional string	Email delivery default, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection_default optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies_default optional boolean
max_attachment_size_default optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
default_timezone optional string	Default timezone for new users. For groups with subgroups, only settable on the parent group. The timezone string should corresponding to a file in the IANA Time Zone database.
disable_edits optional boolean
disable_no_email optional boolean
auto_close_threads optional boolean
close_threads_after optional number
auto_moderate_threads optional boolean
moderate_threads_after optional number
allow_reposts optional boolean	If true, members can repost messages. Only used with premium and enterprise groups.
min_days_between_reposts optional number	The minimum number of days between reposts.
max_number_of_reposts optional number	The maximum number of times a member can repost their message.
lock_group optional boolean

Returns

Returns the group object if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

bad_request	"name exists" is returned if the group name is already taken.
bad_request	"invalid group_name" is returned if it's a bad group name.

Notes

A stand alone/parent group cannot have all the fields announce, restricted, moderated, and new_users_moderated all set to false. If you do this, new_users_moderated will automatically be set to true.
A stand alone/parent group with private archives cannot later be switched to having public archives.
A subgroup with archives that are private to the subgroup cannot be later switched to either public archives or to archives that are viewable by the parent group.
If disable_no_email is changed to true, any member subscriptions that were set to email_delivery_none will automatically be changed to email_delivery_special. Also if email_delivery_default is set to email_delivery_none, it will be changed to email_delivery_special.
If force_html_emails is changed to true, any member subscriptions that were set to email_delivery_digest will automatically be changed to email_delivery_html_digest. Also if email_delivery_default is set to email_delivery_digest, it will be changed to email_delivery_html_digest.
If a group has alias set, that field cannot be unset/set to blank.
If this is a subgroup, the name field has to be of the form ParentGroupName+SubGroupName.

POST /api/v1/updategroup

$ curl "https://groups.io/api/v1/updategroup" \
-b "cookies.curl" \
-d group_id=2 \
-d chat_access=group_access_limited \
-d csrf=12345

Example Successful Response:View Group definition

 {
 "id": 45,
 "object": "group",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "title": "The Example Group",
 "name": "example",
 "nice_group_name": "",
 "alias": "",
 "desc": "This is the description for the example group.",
 "plain_desc": "This is the description for the example group.",
 "subject_tag": "[example]",
 "footer": "",
 "website": "",
 "announce": false,
 "moderated": false,
 "new_users_moderated": false,
 "unmoderate_users_after": 71,
 "restricted": false,
 "allow_non_subs_to_post": false,
 "force_html_emails": false,
 "normalize_html_emails": false,
 "reply_to": "group_reply_only_to_sender",
 "remove_other_reply_options": false,
 "privacy": "group_privacy_archives",
 "seperate_footers": false,
 "allow_downloads": "allow_downloads_by_members",
 "members_visible": "group_view_members_moderators",
 "subgroup_access": "sub_group_moderators",
 "calendar_access": "group_access_limited",
 "files_access": "group_access_limited",
 "database_access": "group_access_limited",
 "wiki_access": "group_access_limited",
 "photos_access": "group_access_limited",
 "member_directory_access": "group_access_limited",
 "polls_access": "polls_access_limited",
 "chat_access": "group_access_limited",
 "handle_attachments": "group_attachments_bounced",
 "plain_text_only": false,
 "handle_virus": "handle_virus_block",
 "locked": false,
 "has_cover_photo": false,
 "has_icon": false,
 "parent_group_id": 8,
 "org_id": 98,
 "max_photo_size_email": "max_photo_size_ex_small",
 "max_photo_size_photos": "max_photo_size_ex_small",
 "max_photo_size_databases": "max_photo_size_ex_small",
 "max_photo_size_wiki_images": "max_photo_size_ex_small",
 "hash_tags_required": false,
 "hash_tag_permissions": "hash_tag_create_mods_bounce",
 "bounce_attachments": false,
 "allow_photos_in_files": false,
 "allow_reposts": false,
 "min_days_between_reposts": 34,
 "max_number_of_reposts": 79,
 "email_delivery_default": "email_delivery_digest",
 "message_selection_default": "message_selection_all",
 "auto_follow_replies_default": false,
 "max_attachment_size_default": "max_attachment_size_large",
 "default_timezone": "",
 "default_time_pref": "military_time",
 "default_date_pref": "international_date",
 "default_monday_start": false,
 "disable_edits": false,
 "disable_no_email": false,
 "auto_close_threads": false,
 "close_threads_after": 54,
 "auto_moderate_threads": false,
 "moderate_threads_after": 21,
 "subgroupcategoryid": 87,
 "subs_count": 26,
 "pending_subs_count": 10,
 "pending_msgs_count": 21,
 "open_chats_count": 67,
 "threads_count": 1,
 "messages_count": 49,
 "org_domain": "",
 "most_recent_message": "2009-11-10T15:00:00-08:00",
 "cover_photo_url": "",
 "icon_url": "",
 "group_url": "",
 "allow_parent_subs_to_post": false,
 "send_event_summaries": false,
 "event_summary_schedule": "event_summary_monthly",
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Group#

Delete a group or a subgroup.

Permissions Needed

You must have the delete_group permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
understand required string	The string "I understand".
csrf required string	The `csrf_token` from the user object returned when first logged in.
reason optional string	A reason for deleting the group.

Returns

Returns an error if update parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

"bad_request"	"understand" is returned if the proper string isn't passed in with the understand POST parameter.

Notes

Delete is permanent.
If the group has subgroups, all subgroups are also deleted.
If the group is not a subgroup (ie is a parent group or a stand alone group), the group name will not be recycled for some time and cannot be used again.

POST /api/v1/deletegroup

$ curl "https://groups.io/api/v1/deletegroup" \
-b "cookies.curl" \
-d group_id=2 \
-d understand=I+understand \
-d csrf=12345

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Hashtags

Get Hashtags#

Get hashtags

Permissions Needed

You must have the hashtags_visible permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
usable_only optional boolean	If true, only return hashtags that the person has permission to use.
exclude_aliases optional boolean	If true, exclude hashtags that have been aliased to other hashtags.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns a hashtag list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/gethashtags

$ curl "https://groups.io/api/v1/gethashtags" \
-b "cookies.curl"

Example Successful Response:View Hashtag List definition

 {
 "object": "list",
 "total_count": 88,
 "start_item": 20,
 "end_item": 74,
 "has_more": false,
 "next_page_token": 1,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 40,
    "object": "hashtag",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 73,
    "name": "",
    "alias": 
      {
      },
    "mods_only_post": false,
    "mods_only_replies": false,
    "no_email": false,
    "moderated": false,
    "special": false,
    "replies_unmoderated": false,
    "locked": false,
    "until": "hash_tag_delete_day",
    "close_instead_of_delete": false,
    "description": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "reply_to": "thread_reply_group_default",
    "topic_count": 96,
    "last_message_date": "2009-11-10T15:00:00-08:00",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Login

Login#

Authenticate a user and return a login object, including HTTP cookies that are needed to access other API functions.

Query Parameters

email required string	The email address of the user.
password required string	The password of the user.
twofactor optional number	If the user account is configured to require two factor authentication, the second factor from an Authenticator app.
api_key optional string	If you have an API key, specify it here.

Returns

Returns a login object if a valid email address/password pair is provided. In addition, one or more HTTP cookies are set in the response. Returns an error otherwise. If the account is configured to require two factor authentication, and the twofactor parameter is not provided, an two_factor_required is returned.

POST /api/v1/login

$ curl "https://groups.io/api/v1/login" \
-c "cookies.curl" \
-d email=test@example.com&password=qwerty&api_key=nonce

Example Successful Response:View Login definition

 {
 "token": "aabbffed2213234",
 "user": 
   {
    "id": 66,
    "object": "user",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "email": "user@example.com",
    "full_name": "",
    "user_name": "",
    "timezone": "",
    "status": "user_status_bounced",
    "profile_photo_url": "",
    "post_pref": "",
    "per_page_pref": "",
    "allow_facebook_login": false,
    "allow_google_login": false,
    "allow_sso_login": false,
    "csrf_token": "",
    "two_factor_enabled": false,
    "recovery_codes": "",
    "dont_munge_message_id": false,
    "about_me": "",
    "about_format": "",
    "location": "",
    "website": "",
    "time_pref": "",
    "date_pref": "",
    "monday_start": false,
    "profile_privacy": "",
    "default_message_view": "expanded_message_view",
    "topics_sort_dir": "",
    "topic_sort_dir": "",
    "messages_sort_dir": "",
    "expanded_messages_sort_dir": "",
    "search_sort": "",
    "search_sort_dir": "",
    "photos_order_by": "",
    "photos_sort_dir": "",
    "album_order_by": "",
    "album_sort_dir": "",
    "home_page": "",
    "subscriptions": [
      {
       "id": 75,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 10,
       "group_id": 72,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 13,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 14,
       "pending_subs": 59,
       "pending_msgs": 25,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      }
    ],
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Logout#

Clear all cookies associated with authentication.

Returns

Returns HTTP 200 on success.

GET /api/v1/logout

$ curl "https://groups.io/api/v1/logout"

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Facebook Login Start#

Start the Facebook login process.

Returns

Returns an oauth login object. Returns an error otherwise.

GET /api/v1/facebookloginstart

$ curl "https://groups.io/api/v1/facebookloginstart"

Example Successful Response:View Oauth Login definition

 {
 "object": "oauth_login",
 "state": "12345",
 "web_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "ios_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "android_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "scopes": ["user"],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Facebook Login Final#

Complete the Facebook login process. If the email address returned by Facebook matches an existing Groups.io user, then that user is logged in. If it does not match an existing user, a new user is created and logged in.

POST Parameters

state required string	Returned from earlier call to /facebookloginstart.
code required string	Returned from Facebook. Either code or access_token is required. If code is specified, we will exchange it for an access_token.
access_token required string	The access token from Facebook. Either code or access_token is required.

Returns

Returns a login object if a valid code and state are present. In addition, one or more HTTP cookies are set in the response. Returns an error otherwise.

Additional Errors

"bad_request"	"invalid state" is returned if the state parameter is invalid or missing.
"bad_request"	"invalid code or access_token" is returned if the code and access_token parameters are invalid or missing.
"bad_request"	"expired code" is returned if the code parameter is expired. Start the process over in this case.
"bad_request"	"inactive user" is returned if the user has been disabled.
"bad_request"	"invalid email address" is returned if the email address returned by Facebook is empty or invalid.
"bad_request"	"two factor enabled" is returned if the user has two-factor authentication enabled, which prevents Facebook logins.
"bad_request"	"facebook login prevented" is returned if the user has disabled Facebook logins. When this error is returned, an email is sent to the user with a link to enable Facebook logins.

POST /api/v1/facebookloginfinal

$ curl "https://groups.io/api/v1/facebookloginfinal \"
-c "cookies.curl" \
-d code=xxx&state=yyy

Example Successful Response:View Login definition

 {
 "token": "aabbffed2213234",
 "user": 
   {
    "id": 46,
    "object": "user",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "email": "user@example.com",
    "full_name": "",
    "user_name": "",
    "timezone": "",
    "status": "user_status_bounced",
    "profile_photo_url": "",
    "post_pref": "",
    "per_page_pref": "",
    "allow_facebook_login": false,
    "allow_google_login": false,
    "allow_sso_login": false,
    "csrf_token": "",
    "two_factor_enabled": false,
    "recovery_codes": "",
    "dont_munge_message_id": false,
    "about_me": "",
    "about_format": "",
    "location": "",
    "website": "",
    "time_pref": "",
    "date_pref": "",
    "monday_start": false,
    "profile_privacy": "",
    "default_message_view": "expanded_message_view",
    "topics_sort_dir": "",
    "topic_sort_dir": "",
    "messages_sort_dir": "",
    "expanded_messages_sort_dir": "",
    "search_sort": "",
    "search_sort_dir": "",
    "photos_order_by": "",
    "photos_sort_dir": "",
    "album_order_by": "",
    "album_sort_dir": "",
    "home_page": "",
    "subscriptions": [
      {
       "id": 21,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 44,
       "group_id": 63,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 36,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 87,
       "pending_subs": 88,
       "pending_msgs": 23,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      }
    ],
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Google Login Start#

Start the Google login process.

Returns

Returns an oauth login object. Returns an error otherwise.

GET /api/v1/googleloginstart

$ curl "https://groups.io/api/v1/googleloginstart"

Example Successful Response:View Oauth Login definition

 {
 "object": "oauth_login",
 "state": "12345",
 "web_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "ios_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "android_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "scopes": ["user"],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Google Login Final#

Complete the Google login process. If the email address returned by Google matches an existing Groups.io user, then that user is logged in. If it does not match an existing user, a new user is created and logged in.

POST Parameters

state required string	Returned from Google.
code required string	Returned from Google. Either code or access_token is required. If code is specified, we will exchange it for an access_token.
access_token required string	The access token from Google. Either code or access_token is required.

Returns

Returns a login object if a valid code and state are present. In addition, one or more HTTP cookies are set in the response. Returns an error otherwise.

Additional Errors

"bad_request"	"invalid state" is returned if the state parameter is invalid or missing.
"bad_request"	"invalid code" is returned if the code parameter is invalid or missing.
"bad_request"	"inactive user" is returned if the user has been disabled.
"bad_request"	"two factor enabled" is returned if the user has two-factor authentication enabled, which prevents Google logins.
"bad_request"	"invalid email address" is returned if the email address returned by Facebook is empty or invalid.
"bad_request"	"google login prevented" is returned if the user has disabled Google logins. When this error is returned, an email is sent to the user with a link to enable Google logins.

POST /api/v1/googleloginfinal

$ curl "https://groups.io/api/v1/googleloginfinal \"
-c "cookies.curl" \
-d code=xxx&state=yyy

Example Successful Response:View Login definition

 {
 "token": "aabbffed2213234",
 "user": 
   {
    "id": 25,
    "object": "user",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "email": "user@example.com",
    "full_name": "",
    "user_name": "",
    "timezone": "",
    "status": "user_status_bounced",
    "profile_photo_url": "",
    "post_pref": "",
    "per_page_pref": "",
    "allow_facebook_login": false,
    "allow_google_login": false,
    "allow_sso_login": false,
    "csrf_token": "",
    "two_factor_enabled": false,
    "recovery_codes": "",
    "dont_munge_message_id": false,
    "about_me": "",
    "about_format": "",
    "location": "",
    "website": "",
    "time_pref": "",
    "date_pref": "",
    "monday_start": false,
    "profile_privacy": "",
    "default_message_view": "expanded_message_view",
    "topics_sort_dir": "",
    "topic_sort_dir": "",
    "messages_sort_dir": "",
    "expanded_messages_sort_dir": "",
    "search_sort": "",
    "search_sort_dir": "",
    "photos_order_by": "",
    "photos_sort_dir": "",
    "album_order_by": "",
    "album_sort_dir": "",
    "home_page": "",
    "subscriptions": [
      {
       "id": 26,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 19,
       "group_id": 0,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 14,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 30,
       "pending_subs": 76,
       "pending_msgs": 0,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      }
    ],
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Member Notices

Endpoints to manipulate member notices.

New Member Notice#

Create a new member notice.

Permissions Needed

You must have the manage_group_settings permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf required string	The `csrf_token` from the user object returned when first logged in.
name required string	Name of this member notice
type required string	Type of member notice
subject required string	Subject used when sending emails
message required string	The message, in HTML format
guidelines_subject optional string	For Guidelines, the subject to use when sending the monthly email
is_default optional boolean	Use this message for email commands
send_on_join optional boolean	For Guidelines, send to new members at same time as welcome message
send_monthly optional boolean	For Guidelines, send monthly to the group members
send_monthly_special optional boolean	For Guidelines, send monthly to members on special only
private optional boolean	For Guidelines, if the guidelines are public or for members only

Returns

Returns a member notice object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid name" is returned if the name is missing or invalid.
"bad_request"	"invalid subject" is returned if the subject is missing or invalid.
"bad_request"	"invalid type" is returned if the type is missing or invalid.
"bad_request"	"invalid message" is returned if the message is missing or invalid.
"bad_request"	"already have guidelines" is returned if the message is of type `group_message_guidelines` and there already is a notice of the same type.

POST /api/v1/newmembernotice

$ curl "https://groups.io/api/v1/newmembernotice" \
-b "cookies.curl" \
-d group_id=12&subject=Test&name=testing&csrf=1234

Example Successful Response:View Member Notice definition

 {
 "id": 51,
 "object": "member_notice",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 34,
 "type": "member_notice_banned",
 "name": "",
 "subject": "",
 "message": "",
 "is_default": false,
 "send_monthly": false,
 "send_monthly_special": false,
 "send_on_join": false,
 "private": false,
 "guidelines_monthly_subject": "",
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Member Notice#

Update a member notice object.

Permissions Needed

You must have the manage_group_settings permission to use this call with a group.

POST Parameters

member_notice_id required integer	ID of the member notice to update.
csrf required string	The `csrf_token` from the user object returned when first logged in.
name optional string	Name of this member notice
type optional string	Type of member notice
subject optional string	Subject used when sending emails
message optional string	The message, in HTML format
guidelines_subject optional string	For Guidelines, the subject to use when sending the monthly email
is_default optional boolean	Use this message for email commands
send_on_join optional boolean	For Guidelines, send to new members at same time as welcome message
send_monthly optional boolean	For Guidelines, send monthly to the group members
send_monthly_special optional boolean	For Guidelines, send monthly to members on special only
private optional boolean	For Guidelines, if the guidelines are public or for members only

Returns

Returns the member-notice object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid member_notice_id" is returned if the member_notice id is missing or invalid.
"bad_request"	"already have guidelines" is returned if the message is of type `group_message_guidelines` and there already is a notice of the same type.

POST /api/v1/updatemembernotice

$ curl "https://groups.io/api/v1/updatemembernotice" \
-b "cookies.curl" \
-d member_notice_id=12&subject=Test&name=testing&csrf=1234

Example Successful Response:View Member Notice definition

 {
 "id": 19,
 "object": "member_notice",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 66,
 "type": "member_notice_banned",
 "name": "",
 "subject": "",
 "message": "",
 "is_default": false,
 "send_monthly": false,
 "send_monthly_special": false,
 "send_on_join": false,
 "private": false,
 "guidelines_monthly_subject": "",
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Member Notice#

Delete a member notice object.

Permissions Needed

You must have the manage_group_settings permission to use this call with a group.

POST Parameters

member_notice_id required integer	ID of the member notice to delete.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"invalid member_notice_id" is returned if the member notice id is missing or invalid.

POST /api/v1/deletemembernotice

$ curl "https://groups.io/api/v1/deletemembernotice" \
-b "cookies.curl" \
-d member_notice_id=12&csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Member Notices#

Get member notices. Member notices are returned using the pagination request and object format.

Permissions Needed

You must have the manage_group_settings permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are dependent on the call.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns a member notice list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/getmembernotices

$ curl "https://groups.io/api/v1/getmembernotices?group_id=12" \
-b "cookies.curl"

Example Successful Response:View Member Notice List definition

 {
 "object": "list",
 "total_count": 13,
 "start_item": 45,
 "end_item": 41,
 "has_more": false,
 "next_page_token": 42,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 39,
    "object": "member_notice",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 94,
    "type": "member_notice_banned",
    "name": "",
    "subject": "",
    "message": "",
    "is_default": false,
    "send_monthly": false,
    "send_monthly_special": false,
    "send_on_join": false,
    "private": false,
    "guidelines_monthly_subject": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Members

Approve Pending Member#

Approve a pending member.

Permissions Needed

You must have the manage_pending_members permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a member info object if the approval succeeded. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

Notes

The active Welcome member notice will be sent to the member, if there is one.
A subscription notification will be sent to all owners/moderators with that notification enabled.

POST /api/v1/approvemember

$ curl "https://groups.io/api/v1/approvemember" \
-b "cookies.curl" \
-d group_id=1 \
-d member_info_id=2 \
-d csrf=12345

Example Successful Response:View Member Info definition

 {
 "id": 21,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 74,
 "group_id": 1,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 50,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 85,
 "pending_subs": 88,
 "pending_msgs": 64,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Ban Member#

Ban this member.

Permissions Needed

You must have the ban_members permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a member info if the ban succeeded. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

bad_request	"user already banned" is returned if the member's `status` is already `sub_status_banned`
bad_request	"member cannot be a moderator or owner" is returned if the member's `mod_status` is not `sub_modstatus_none`

POST /api/v1/banmember

$ curl "https://groups.io/api/v1/banmember" \
-b "cookies.curl" \
-d group_id=1 \
-d member_info_id=2 \
-d csrf=12345

Example Successful Response:View Member Info definition

 {
 "id": 60,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 16,
 "group_id": 19,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 82,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 16,
 "pending_subs": 13,
 "pending_msgs": 16,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Bulk Remove Members#

Remove one or more members from a group.

Permissions Needed

You must have the remove_members permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
emails required string	A newline separated list of email addresses to remove.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a bulk remove results object if the bulk remove succeeded. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

Notes

If a removed member's status is sub_status_pending, the active Rejected Subscription member notice will be sent to the member, if there is one.
If a removed member's status is sub_status_normal, the active Removed Member notice will be sent to the member, if there is one.
If a removed member's status is sub_status_banned, no member notices will be sent out.

POST /api/v1/bulkremovemembers

$ curl "https://groups.io/api/v1/bulkremovemembers" \
-b "cookies.curl" \
-d group_id=1 \
-d $'emails=test@example.com\njohn@smith.com` \
-d csrf=12345

TODO: FIX

Example Successful Response:View Member Info definition

 {
 "id": 22,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 1,
 "group_id": 55,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 77,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 63,
 "pending_subs": 17,
 "pending_msgs": 58,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Direct Add#

Directly add people to a group.

Permissions Needed

You must have the invite_members permission to use this call. In addition, the group must be a Premium or Enterprise group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
emails required string	A newline separated list of email addresses to add.
csrf string	The `csrf_token` from the user object returned when first logged in.
subject optional string	Subject line to use for the direct add notification sent to users.
message optional string	Message to include with the direct add notification sent to users.
subgroupids optional string	A comma separated list of IDs of sub groups to also add these people to.
subgroupnames optional string	A comma separated list of names of sub groups to also add these people to.

Returns

Returns a direct add results object if the approval succeeded. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

bad_request	"basic group" is returned if the group is not a premium or enterprise group.
bad_request	"direct add in subgroup" is returned if the group_id refers to a subgroup and not a main group.
bad_request	"group is not a subgroup" is returned if a group ID in `subgroupids` refers to a group that is not a subgroup of the group.
pending_adds	Is returned if the adds require approval. The adds will take place once they have been reviewed.

Notes

For premium groups, there is a limit to the number of direct adds that can be done to a group per-day. Go over that limit and the pending_adds message will be returned. There is no daily limit for Enterprise groups.
If a subgroupid or subgroupname is specified that is actually a group alias, the pointed-to group will be used instead.

POST /api/v1/directadd

$ curl "https://groups.io/api/v1/directadd" \
-b "cookies.curl" \
-d group_id=4 \
-d $'emails=test@example.com\nJohn Smith <john@smith.com>` \
-d csrf=12345

Example Successful Response:View Direct Add Results definition

 {
 "object": "direct_add_results",
 "total_emails": 32,
 "errors": [
   {
    "object": "direct_add_error",
    "email": "",
    "status": "",
    "group_id": 79,
   }
 ],
 "added_members": [
   {
    "id": 75,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 40,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 27,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 34,
    "pending_subs": 52,
    "pending_msgs": 28,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Member#

Get a member of a group. A member is represented by a member info object.

Permissions Needed

You must have the view_members permission to use this call.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object

Returns

Returns a member info object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

No additional errors

GET /api/v1/getmember

$ curl "https://groups.io/api/v1/getmember?group_id=2&member_info_id=46" \
-b "cookies.curl"

Example Successful Response:View Member Info definition

 {
 "id": 37,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 47,
 "group_id": 69,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 12,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 46,
 "pending_subs": 9,
 "pending_msgs": 4,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Members#

Get the members of a group. Each member is represented by a member info object. Member info objects are returned using the pagination request and object format.

Permissions Needed

You must have the view_members permission to use this call.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
type optional	The type of member to be returned, can be `pending`, `banned`, `mods`, `members`. See Notes for restrictions. Default: `members`
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `full_name`, `email`, `delivery`, `joined`.
sort_dir optional string	Sort direction. Can be 'asc' or 'desc'.

Returns

Returns a member info list object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

No additional errors

Notes

If you do not have the manage_pending_members permission, you cannot specify the type pending.
If you do not have the ban_members permission, you cannot specify the type banned.

GET /api/v1/getmembers

$ curl "https://groups.io/api/v1/getmembers?group_id=7" \
-b "cookies.curl"

Example Successful Response:View Member Info List definition

 {
 "object": "list",
 "total_count": 56,
 "start_item": 14,
 "end_item": 89,
 "has_more": false,
 "next_page_token": 23,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 42,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 64,
    "group_id": 39,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 30,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 19,
    "pending_subs": 53,
    "pending_msgs": 60,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Past Members#

Get the past members of a group. Each member is represented by a past member object. Objects are returned using the pagination request and object format.

Permissions Needed

You must have the view_members permission to use this call. In addition, the group must be a Premium or Enterprise group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `full_name`, `email`, `reason`, `created`.
sort_dir optional string	Sort direction. Can be 'asc' or 'desc'.

Returns

Returns a past member list object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

No additional errors

GET /api/v1/getpastmembers

$ curl "https://groups.io/api/v1/getpastmembers?group_id=7" \
-b "cookies.curl"

Example Successful Response:View Past Member List definition

 {
 "object": "list",
 "total_count": 94,
 "start_item": 85,
 "end_item": 21,
 "has_more": false,
 "next_page_token": 13,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 1,
    "object": "past_member",
    "created": "2009-11-10T15:00:00-08:00",
    "action": "spamleft",
    "member_info": 
      {
       "id": 28,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 57,
       "group_id": 84,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 62,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 83,
       "pending_subs": 21,
       "pending_msgs": 50,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Remove Member#

Remove a member from a group.

Permissions Needed

You must have the remove_members permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

No additional errors

Notes

If the member's status is sub_status_pending, the active Rejected Subscription member notice will be sent to the member, if there is one.
If the member's status is sub_status_normal, the active Removed Member notice will be sent to the member, if there is one.
If the member's status is sub_status_banned, no member notices will be sent out.

POST /api/v1/removemember

$ curl "https://groups.io/api/v1/removemember" \
-b "cookies.curl" \
-d group_id=1 \
-d member_info_id=2 \
-d csrf=12345

Example Successful Response:View Member Info definition

 {
 "id": 15,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 40,
 "group_id": 92,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 42,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 91,
 "pending_subs": 98,
 "pending_msgs": 1,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Search Members#

Search the members of a group. The search is over email addresses and full names. Each member is represented by a member info object. Member info objects are returned using the pagination request and object format.

Permissions Needed

You must have the view_members permission to use this call.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
q required string	Email or name fragment to search on.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `full_name`, `email`, `delivery`, `joined`.
sort_dir optional string	Sort direction. Can be 'asc' or 'desc'.

Returns

Returns a member info list object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

No additional errors

GET /api/v1/searchmembers

$ curl "https://groups.io/api/v1/searchmembers?group_id=7&q=smith.com" \
-b "cookies.curl"

Example Successful Response:View Member Info List definition

 {
 "object": "list",
 "total_count": 7,
 "start_item": 12,
 "end_item": 95,
 "has_more": false,
 "next_page_token": 16,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 52,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 83,
    "group_id": 55,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 69,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 40,
    "pending_subs": 94,
    "pending_msgs": 98,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Send A Bounce Probe#

Send a bounce probe.

Permissions Needed

You must have the manage_member_subscription_options permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a member info object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

bad_request	"user not bouncing" is returned if the member's `user_status` is not either `user_status_bouncing` and `user_status_bounced`

POST /api/v1/sendbounceprobe

$ curl "https://groups.io/api/v1/sendbounceprobe" \
-b "cookies.curl" \
-d group_id=1 \
-d member_info_id=2 \
-d csrf=12345

Example Successful Response:View Member Info definition

 {
 "id": 90,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 17,
 "group_id": 82,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 14,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 70,
 "pending_subs": 82,
 "pending_msgs": 68,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Send A Confirmation Email#

Send a confirmation email.

Permissions Needed

You must have the manage_member_subscription_options permission to use this call.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a member info object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

bad_request	"user not unconfirmed" is returned if the member's `user_status` is not `user_status_not_confirmed`

POST /api/v1/sendconfirmation

$ curl "https://groups.io/api/v1/sendconfirmation" \
-b "cookies.curl" \
-d group_id=1 \
-d member_info_id=2 \
-d csrf=12345

Example Successful Response:View Member Info definition

 {
 "id": 76,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 26,
 "group_id": 96,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 25,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 68,
 "pending_subs": 62,
 "pending_msgs": 43,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Send Invites#

Send invites.

Permissions Needed

You must have the send_invites permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
emails required string	A newline separated list of email addresses to invite.
csrf string	The `csrf_token` from the user object returned when first logged in.

Returns

NOTE: This call is not yet finished and documented.

Additional Errors

No additional errors

POST /api/v1/invite

$ curl "https://groups.io/api/v1/invite" \
-b "cookies.curl" \
-d group_id=4 \
-d $'emails=test@example.com\nJohn Smith <john@smith.com>` \
-d csrf=12345

Example Successful Response:View Direct Add Results definition

 {
 "object": "direct_add_results",
 "total_emails": 51,
 "errors": [
   {
    "object": "direct_add_error",
    "email": "",
    "status": "",
    "group_id": 21,
   }
 ],
 "added_members": [
   {
    "id": 13,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 9,
    "group_id": 93,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 70,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 37,
    "pending_subs": 86,
    "pending_msgs": 41,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Member#

Change a member's subscription.

Permissions Needed

You must have the manage_member_subscription_options permission to use this call, in addition to any permissions specified below.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf required string	The `csrf_token` from the user object returned when first logged in.
post_status optional string	Posting status, can be `sub_poststatus_normal`, `sub_poststatus_allowed`, `sub_poststatus_moderated`, `sub_poststatus_notallowed`, `sub_poststatus_newusermoderated`
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
full_name optional string
moderator_notes optional string
You must have the `make_moderator` permission in order to set these fields
mod_status optional string	Moderator status, can be `sub_modstatus_none`, `sub_modstatus_moderator`, `sub_modstatus_owner`
mod_permissions optional string	Moderator permissions, comma separated list of zero or more of the following: `sub_perm_pendingmsgs`, `sub_perm_pendingmembers`, `sub_perm_invitemembers`, `sub_perm_removemembers`, `sub_perm_banmembers`, `sub_perm_makemoderator`, `sub_perm_createhashtags`, `sub_perm_groupsettings`, `sub_perm_modsub`, `sub_perm_integrations`, `sub_perm_editarchives`, `sub_perm_billing`, `sub_perm_managesubgroups`
pending_msg_notify optional string	Notify about pending messages, can be `sub_notify_email`, `sub_notify_none`
pending_sub_notify optional string	Notify about pending subscriptions, can be `sub_notify_email`, `sub_notify_none`
sub_notify optional string	Notify when someone joins the group, can be `sub_notify_email`, `sub_notify_none`
storage_notify optional string	Notify when storage limits are reached, can be `sub_notify_email`, `sub_notify_none`
sub_group_notify optional string	Notify when a subgroup is created, can be `sub_notify_email`, `sub_notify_none`
message_report_notify optional string	Notify when someone reports a message, can be `sub_notify_email`, `sub_notify_none`
owner_msg_notify optional string	Receive messages sent to the +owner address, can be `sub_ownermsg_notify_all`, `sub_ownermsg_notify_subs`, `sub_ownermsg_notify_none`

Returns

Returns a member info object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

"bad_request"	"no owners" is returned if changing the `mod_status` field will leave the group without any owners.

Notes

If email_delivery is switched from either email_delivery_digest or email_delivery_html_digest to one of the non-digest options, and there are pending digest messages, a digest will be generated at this time.

POST /api/v1/updatemember

$ curl "https://groups.io/api/v1/updatemember" \
-b "cookies.curl" \
-d group_id=1 \
-d member_info_id=2 \
-d csrf=12345 \
-d post_status=sub_poststatus_normal

Example Successful Response:View Member Info definition

 {
 "id": 90,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 98,
 "group_id": 85,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 1,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 58,
 "pending_subs": 18,
 "pending_msgs": 92,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Notifications

These API endpoints deal with device notifications.

Register Device#

Permissions Needed

None.

POST Parameters

token required string	Device ID token as provided by Expo.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"invalid token" is returned if the token is missing or invalid.

POST /api/v1/registerdevice

$ curl "https://groups.io/api/v1/registerdevice" \
-b "cookies.curl" \
-d token=abcdef&csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Test Notification#

Send a test notification. Sends a test notification to all devices registered to this user. This endpoint is probably temporary.

Permissions Needed

None.

POST Parameters

csrf required string	The `csrf_token` from the user object returned when first logged in.
token optional string	Device ID token. If this is not specified, any existing registered tokens will be used.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"invalid token" is returned if the token is missing or invalid.

POST /api/v1/testnotification

$ curl "https://groups.io/api/v1/testnotification" \
-b "cookies.curl" \
-d csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Photos

These are the API endpoints for albums and photos.

New Photo Album#

Create a new photo album. The album is created.

Permissions Needed

You must have the manage_photos permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
title required string	The title of the album.
desc required string	The description of the album, in plain text format.
upload_perms required string	Who can upload photos to this album. Can be: `album_upload_group` or `album_upload_personal`.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a album object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid title" is returned if the title is missing or invalid.
"bad_request"	"invalid desc" is returned if the desc is missing or invalid.
"bad_request"	"invalid upload_perms" is returned if the upload_perms parameter is missing or invalid.

POST /api/v1/newalbum

$ curl "https://groups.io/api/v1/newalbum" \
-b "cookies.curl" \
-d group_id=12&title=Test&desc=testing&csrf=1234

Example Successful Response:View Album definition

 {
 "id": 35,
 "object": "album",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 15,
 "group_id": 81,
 "upload_perms": "",
 "title": "",
 "desc": "",
 "cover_photo_thumbnail_url": "",
 "cover_photo_url": "",
 "total_photos": 48,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Photo Album#

Update a photo album.

Permissions Needed

You must be the owner of the album.

POST Parameters

album_id required integer	ID of the album.
title optional string	The title of the album.
desc optional string	The description of the album, in plain text format.
upload_perms optional string	Who can upload photos to this album. Can be: `album_upload_group` or `album_upload_personal`.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a album object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid album_id" is returned if the album_id is missing or invalid.
"bad_request"	"invalid title" is returned if the title is invalid.
"bad_request"	"invalid desc" is returned if the desc is invalid.
"bad_request"	"invalid upload_perms" is returned if the upload_perms parameter is invalid.

POST /api/v1/updatealbum

$ curl "https://groups.io/api/v1/updatealbum" \
-b "cookies.curl" \
-d album_id=32&title=Test&desc=testing&csrf=1234

Example Successful Response:View Album definition

 {
 "id": 56,
 "object": "album",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 17,
 "group_id": 74,
 "upload_perms": "",
 "title": "",
 "desc": "",
 "cover_photo_thumbnail_url": "",
 "cover_photo_url": "",
 "total_photos": 99,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Photo Albums#

Get photo albums. ALbums are returned using the pagination request and object format.

Permissions Needed

You must have the view_photos permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are: `title`, `created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns an album list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

Notes

Depending on settings, the first album returned may be the Emailed Photos album, which is an album of photos that were sent through messages. This album will have an ID of 0.

GET /api/v1/getalbums

$ curl "https://groups.io/api/v1/getalbums?group_id=12" \
-b "cookies.curl"

Example Successful Response:View Album List definition

 {
 "object": "list",
 "total_count": 73,
 "start_item": 51,
 "end_item": 61,
 "has_more": false,
 "next_page_token": 60,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 92,
    "object": "album",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 24,
    "group_id": 14,
    "upload_perms": "",
    "title": "",
    "desc": "",
    "cover_photo_thumbnail_url": "",
    "cover_photo_url": "",
    "total_photos": 18,
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Photo Album#

Delete a photo album. Any photos within the album that you have permission to delete will be removed. If the photo album is then empty, it is deleted. In order to delete a photo, you must either be the owner of the photo or a moderator/owner of the group.

Permissions Needed

You must be the owner of the album.

POST Parameters

album_id required integer	ID of the album.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid album_id" is returned if the album_id is missing or invalid.

POST /api/v1/deletealbum

$ curl "https://groups.io/api/v1/deletealbum" \
-b "cookies.curl" \
-d album_id=32&csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Add Photos#

Add photos.

Permissions Needed

You must have permission to add photos to the album.

Query Parameters

album_id required integer	ID of the photo album to add the photo to.
fileupload required multipart file	Multipart file upload of one or more photos.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a photo list object if successful. Returns an error if there is an error.

Additional Errors

"bad_request"	"invalid album_id" is returned if the album id is missing or invalid.

POST /api/v1/addphotos

$ curl "https://groups.io/api/v1/addphotos" \
-b "cookies.curl"
-F fileupload=@path_to_file \
-F "album_id=12" \
-F "csrf=12345"

Example Successful Response:View Photo List definition

 {
 "object": "list",
 "total_count": 63,
 "start_item": 35,
 "end_item": 48,
 "has_more": false,
 "next_page_token": 50,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "album": 
   {
    "id": 40,
    "object": "album",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 52,
    "group_id": 90,
    "upload_perms": "",
    "title": "",
    "desc": "",
    "cover_photo_thumbnail_url": "",
    "cover_photo_url": "",
    "total_photos": 66,
   },
 "data": [
   {
    "id": 99,
    "object": "photo",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 60,
    "group_id": 94,
    "name": "",
    "desc": "",
    "media_type": "image/jpeg",
    "size": 10,
    "attachment_num": 51,
    "width": 66,
    "height": 1,
    "album_id": 22,
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
    "format": "gif",
    "focal_length": 3.2,
    "iso": 60,
    "aperture": 3.2,
    "shutter_speed": 34,
    "taken": 13,
    "make": "",
    "model": "",
    "thumbnail_url": "",
    "download_url": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Photo#

Update a photo.

Permissions Needed

You must be the owner of the photo.

POST Parameters

photo_id required integer	ID of the photo.
name optional string	The name of the photo
desc optional string	The description of the photo, in plain text format.
cover_photo optional bool	If true, make this photo the cover photo for the album.
rotate optional number	Degrees to rotate the photo, in increments of 90 degrees. Can be: 90, 180, 270, -90, -180, -270.
album_id optional integer	If provided, this moves the photo to the album. You must have permission to add photos to that album and the album must be in the same group.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a photo object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid photo_id" is returned if the photo_id is missing or invalid.
"bad_request"	"invalid name" is returned if the name is invalid.
"bad_request"	"invalid desc" is returned if the desc is invalid.
"bad_request"	"invalid rotate" is returned if the rotate parameter is invalid.
"bad_request"	"invalid album_id" is returned if the album_id parameter is invalid.

POST /api/v1/updatephoto

$ curl "https://groups.io/api/v1/updatephoto" \
-b "cookies.curl" \
-d photo_id=32&name=Test&desc=testing&csrf=1234

Example Successful Response:View Album definition

 {
 "id": 62,
 "object": "album",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 98,
 "group_id": 17,
 "upload_perms": "",
 "title": "",
 "desc": "",
 "cover_photo_thumbnail_url": "",
 "cover_photo_url": "",
 "total_photos": 93,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Photo#

Get photo.

Permissions Needed

You must have the view_photos permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
album_id required integer	ID of the album that contains the photo, or 0 if viewing a photo sent as a message attachment.
photo_id required integer	ID of the photo to fetch.
attachment_num required number	If viewing a photo sent as a message attachment, this is the `attachment_num` from that photo. If `album_id` is 0, this field must be specified.

Returns

Returns an photo object if successful. Returns an error if there is an error.

Additional Errors

"bad_request"	"invalid album_id" is returned if the album id is invalid or you do not have permission to view it.
"bad_request"	"invalid photo_id" is returned if the photo id is missing or invalid or you do not have permission to view it.

GET /api/v1/getphoto

$ curl "https://groups.io/api/v1/getphoto?group_id=12&album_id=0&photo_id=12&attachment_num=2" \
-b "cookies.curl"

Example Successful Response:View Photo definition

 {
 "id": 40,
 "object": "photo",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 53,
 "group_id": 18,
 "name": "",
 "desc": "",
 "media_type": "image/jpeg",
 "size": 1,
 "attachment_num": 6,
 "width": 88,
 "height": 71,
 "album_id": 77,
 "display_name": "",
 "user_name": "",
 "profile_photo_url": "",
 "profile_privacy": "",
 "email": "",
 "format": "gif",
 "focal_length": 3.2,
 "iso": 42,
 "aperture": 3.2,
 "shutter_speed": 17,
 "taken": 7,
 "make": "",
 "model": "",
 "thumbnail_url": "",
 "download_url": "",
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Photos#

Get photos. Photos are returned using the pagination request and object format.

Permissions Needed

You must have the view_photos permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
album_id required integer	ID of the photo album to view.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are: `created`, `name`, `taken`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns an photo list object if successful. Returns an error if there is an error.

Additional Errors

"bad_request"	"invalid album_id" is returned if the album id is missing or invalid.

Notes

To view the Emailed Photos album, pass in an album_id of 0.

GET /api/v1/getphotos

$ curl "https://groups.io/api/v1/getphotos?group_id=12" \
-b "cookies.curl"

Example Successful Response:View Photo List definition

 {
 "object": "list",
 "total_count": 84,
 "start_item": 50,
 "end_item": 7,
 "has_more": false,
 "next_page_token": 22,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "album": 
   {
    "id": 45,
    "object": "album",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 35,
    "group_id": 48,
    "upload_perms": "",
    "title": "",
    "desc": "",
    "cover_photo_thumbnail_url": "",
    "cover_photo_url": "",
    "total_photos": 30,
   },
 "data": [
   {
    "id": 4,
    "object": "photo",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 62,
    "group_id": 52,
    "name": "",
    "desc": "",
    "media_type": "image/jpeg",
    "size": 75,
    "attachment_num": 14,
    "width": 7,
    "height": 53,
    "album_id": 1,
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
    "format": "gif",
    "focal_length": 3.2,
    "iso": 73,
    "aperture": 3.2,
    "shutter_speed": 1,
    "taken": 95,
    "make": "",
    "model": "",
    "thumbnail_url": "",
    "download_url": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Search Photos#

Search photos. Photos are returned using the pagination request and object format.

Permissions Needed

You must have the view_photos permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
q required string	Query string.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are: `created`, `name`, `taken`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns an photo list object if successful. Returns an error if there is an error.

Additional Errors

"bad_request"	"invalid query" is returned if the query string is empty.

GET /api/v1/searchphotos

$ curl "https://groups.io/api/v1/searchphotos?group_id=12&q=Test" \
-b "cookies.curl"

Example Successful Response:View Photo List definition

 {
 "object": "list",
 "total_count": 50,
 "start_item": 45,
 "end_item": 27,
 "has_more": false,
 "next_page_token": 99,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "album": 
   {
    "id": 38,
    "object": "album",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 99,
    "group_id": 15,
    "upload_perms": "",
    "title": "",
    "desc": "",
    "cover_photo_thumbnail_url": "",
    "cover_photo_url": "",
    "total_photos": 75,
   },
 "data": [
   {
    "id": 43,
    "object": "photo",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 40,
    "group_id": 60,
    "name": "",
    "desc": "",
    "media_type": "image/jpeg",
    "size": 39,
    "attachment_num": 93,
    "width": 51,
    "height": 12,
    "album_id": 78,
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
    "format": "gif",
    "focal_length": 3.2,
    "iso": 81,
    "aperture": 3.2,
    "shutter_speed": 6,
    "taken": 79,
    "make": "",
    "model": "",
    "thumbnail_url": "",
    "download_url": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Photo#

Delete a photo.

Permissions Needed

You must either be the owner of the photo or a moderator/owner of the group.

POST Parameters

photo_id required integer	ID of the photo.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid photo_id" is returned if the photo_id is missing or invalid.

POST /api/v1/deletephoto

$ curl "https://groups.io/api/v1/deletephoto" \
-b "cookies.curl" \
-d photo_id=32&csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Polls

New Poll#

Create a new poll. The poll is created.

Permissions Needed

You must have the manage_polls permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
question required string	The subject of the poll.
desc required string	The description of the poll, in HTML format.
announce required boolean	If `true`, send an announcement of the poll to the group.
answer required string repeated field	Possible answers to the poll. At least two must be specified.
multiple optional boolean	If `true`, allow multiple responses.
results_at_end optional boolean	If `true`, only allow results to be shown after the poll is closed.
no_results optional boolean	If `true`, do not show results.
anonymous optional boolean	If `true`, do not show who voted.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a poll object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Success Responses

"pending post"	Returned if the poll requires approval before it is sent to the group.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid question" is returned if the question is missing or invalid.
"bad_request"	"invalid desc" is returned if the desc is missing or invalid.
"bad_request"	"not enough answers" is returned if there are not enough questions specified.
"bad_request"	"need hashtag" is returned if a hashtag is required in the question.
"bad_request"	"restricted hashtag" is returned if a restricted hashtag is used in the question.
"bad_request"	"mod only hashtag" is returned if a moderator only hashtag is used in the question.
"bad_request"	"post too big" is returned if the resulting post is too large for the group.
"bad_request"	"announce group" is returned if this poll was sent to an announcement group by a non-moderator.

POST /api/v1/newpoll

$ curl "https://groups.io/api/v1/newpoll" \
-b "cookies.curl" \
-d group_id=12&question=Test&desc=testing&answer=answer+1&answer=answer+2&csrf=1234

Example Successful Response:View Poll definition

 {
 "id": 15,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 85,
 "group_id": 11,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "answers": [""],
 "is_closed": false,
 "msg_num": 48,
 "anonymous": false,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Poll#

Update an existing poll.

Permissions Needed

You must have the manage_polls permission to use this call with a group. In addition, you either must be the author of the poll or a moderator of the group.

POST Parameters

poll_id required integer	ID of the poll to update.
question required string	The subject of the poll.
desc required string	The description of the poll, in HTML format.
announce required boolean	If `true`, send an announcement of the poll to the group.
answer required string repeated field	Possible answers to the poll. At least two must be specified.
edit_msg optional string	Reason for changing the poll.
multiple optional boolean	If `true`, allow multiple responses.
results_at_end optional boolean	If `true`, only allow results to be shown after the poll is closed.
no_results optional boolean	If `true`, do not show results.
anonymous optional boolean	If `true`, do not show who voted.
close optional boolean	If `true`, close the poll.
reopen optional boolean	If `true`, reopen the poll.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a poll object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid poll_id" is returned if the poll id is missing or invalid.
"bad_request"	"invalid question" is returned if the question is missing or invalid.
"bad_request"	"invalid desc" is returned if the desc is missing or invalid.
"bad_request"	"not enough answers" is returned if there are not enough questions specified.
"bad_request"	"need hashtag" is returned if a hashtag is required in the question.
"bad_request"	"restricted hashtag" is returned if a restricted hashtag is used in the question.
"bad_request"	"mod only hashtag" is returned if a moderator only hashtag is used in the question.
"bad_request"	"post too big" is returned if the resulting post is too large for the group.
"bad_request"	"announce group" is returned if this poll was sent to an announcement group by a non-moderator.

POST /api/v1/updatepoll

$ curl "https://groups.io/api/v1/updatepoll" \
-b "cookies.curl" \
-d poll_id=12&subject=Test&desc=testing&csrf=1234

Example Successful Response:View Poll definition

 {
 "id": 14,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 93,
 "group_id": 36,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "answers": [""],
 "is_closed": false,
 "msg_num": 55,
 "anonymous": false,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Poll#

Get a poll.

Permissions Needed

You must have the archives_visible permission to use this call with a group.

POST Parameters

poll_id required integer	ID of the poll to update.

Returns

Returns a poll object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid poll_id" is returned if the poll id is missing or invalid.

POST /api/v1/getpoll

$ curl "https://groups.io/api/v1/getpoll" \
-b "cookies.curl" \
-d group_id=12&poll_id=12

Example Successful Response:View Poll definition

 {
 "id": 60,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 36,
 "group_id": 6,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "answers": [""],
 "is_closed": false,
 "msg_num": 83,
 "anonymous": false,
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Poll Results#

Get poll results.

Permissions Needed

You must have the archives_visible permission to use this call with a group.

POST Parameters

poll_id required integer	ID of the poll to update.

Returns

Returns a poll results object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid poll_id" is returned if the poll id is missing or invalid.
"bad_request"	"can't view poll results" is returned if the user cannot view the poll results.

POST /api/v1/getpollresults

$ curl "https://groups.io/api/v1/getpollresults" \
-b "cookies.curl" \
-d group_id=12&poll_id=12

Example Successful Response:View Poll Results definition

 {
 "poll_id": 28,
 "object": "poll_results",
 "results": [
   {
    "answer": "",
    "count": 1,
    "percentage": "",
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Vote#

Vote in a poll.

Permissions Needed

You must have the can_vote permission to use this call with a group.

POST Parameters

poll_id required integer	ID of the poll to update.
csrf required string	The `csrf_token` from the user object returned when first logged in.
answer required number	ID of the answer. Depending on the poll, you may be able to specify multiple answers.

Returns

Returns a poll object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid poll_id" is returned if the poll id is missing or invalid.
"bad_request"	"no answers" is returned if no answers are specified.
"bad_request"	"poll closed" is returned if the poll has been closed.

POST /api/v1/vote

$ curl "https://groups.io/api/v1/vote" \
-b "cookies.curl" \
-d poll_id=12&csrf=1234&answer=2

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Reporting

These is the API endpoint for reporting content.

Report Content#

Report content.

Permissions Needed

You must have permission to add files to the folder.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
report_to required string	Where to send the report. Can be: `mods`, `support`.
reason required string	Reason for the complaint.
csrf required string	The `csrf_token` from the user object returned when first logged in.
message_id string	ID of the `message` object to report. One of `message_id`, `file_id`, or `photo_id` must be included in the request.
file_id string	ID of the `file` object to report. One of `message_id`, `file_id`, or `photo_id` must be included in the request.
photo_id string	ID of the `photo` object to report. One of `message_id`, `file_id`, or `photo_id` must be included in the request.

Returns

Returns HTTP 200 on success. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.a

Additional Errors

"bad_request"	"missing reason" is returned if the reason field is missing or empty.
"bad_request"	"invalid report_to" is returned if the report_to field is invalid.
"bad_request"	"missing either message_id, photo_id, or file_id" is returned if an appropriate ID is not included.

POST /api/v1/reportcontent

$ curl "https://groups.io/api/v1/reportcontent" \
-b "cookies.curl" \
-d reason=Inappropriate&message_id=321&report_to=mods&csrf=1234

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

User

Register User#

POST Parameters

email required string	Email address of the new user.
password required string	Password for the new user.

Returns

Returns a login object if a valid email address/password pair is provided. In addition, one or more HTTP cookies are set in the response. Returns an error otherwise.

Additional Errors

bad_request	"invalid email" is returned if the email address is invalid.
bad_request	"email exists" is returned if the email address already exists.
bad_request	"password too short" is returned if the password is too short.

Notes

A confirmation email will be sent to the new user.

POST /api/v1/registeruser

$ curl "https://groups.io/api/v1/registeruser" \
-c "cookies.curl" \
-d email=test@example.com \
-d password=passw0rd

Example Successful Response:View Login definition

 {
 "token": "aabbffed2213234",
 "user": 
   {
    "id": 12,
    "object": "user",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "email": "user@example.com",
    "full_name": "",
    "user_name": "",
    "timezone": "",
    "status": "user_status_bounced",
    "profile_photo_url": "",
    "post_pref": "",
    "per_page_pref": "",
    "allow_facebook_login": false,
    "allow_google_login": false,
    "allow_sso_login": false,
    "csrf_token": "",
    "two_factor_enabled": false,
    "recovery_codes": "",
    "dont_munge_message_id": false,
    "about_me": "",
    "about_format": "",
    "location": "",
    "website": "",
    "time_pref": "",
    "date_pref": "",
    "monday_start": false,
    "profile_privacy": "",
    "default_message_view": "expanded_message_view",
    "topics_sort_dir": "",
    "topic_sort_dir": "",
    "messages_sort_dir": "",
    "expanded_messages_sort_dir": "",
    "search_sort": "",
    "search_sort_dir": "",
    "photos_order_by": "",
    "photos_sort_dir": "",
    "album_order_by": "",
    "album_sort_dir": "",
    "home_page": "",
    "subscriptions": [
      {
       "id": 79,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 63,
       "group_id": 43,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 87,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 32,
       "pending_subs": 23,
       "pending_msgs": 23,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      }
    ],
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get User#

Return the user information associated with the logged in user.

GET /api/v1/getuser

$ curl "https://groups.io/api/v1/getuser" \
-b "cookies.curl"

Example Successful Response:View User definition

 {
 "id": 25,
 "object": "user",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "email": "user@example.com",
 "full_name": "",
 "user_name": "",
 "timezone": "",
 "status": "user_status_bounced",
 "profile_photo_url": "",
 "post_pref": "",
 "per_page_pref": "",
 "allow_facebook_login": false,
 "allow_google_login": false,
 "allow_sso_login": false,
 "csrf_token": "",
 "two_factor_enabled": false,
 "recovery_codes": "",
 "dont_munge_message_id": false,
 "about_me": "",
 "about_format": "",
 "location": "",
 "website": "",
 "time_pref": "",
 "date_pref": "",
 "monday_start": false,
 "profile_privacy": "",
 "default_message_view": "expanded_message_view",
 "topics_sort_dir": "",
 "topic_sort_dir": "",
 "messages_sort_dir": "",
 "expanded_messages_sort_dir": "",
 "search_sort": "",
 "search_sort_dir": "",
 "photos_order_by": "",
 "photos_sort_dir": "",
 "album_order_by": "",
 "album_sort_dir": "",
 "home_page": "",
 "subscriptions": [
   {
    "id": 90,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 77,
    "group_id": 1,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 1,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 47,
    "pending_subs": 8,
    "pending_msgs": 7,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update User#

Updates the authenticated user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

POST Parameters

csrf required string	The `csrf_token` from the user object returned when first logged in.
email optional string	New email address. The user object will be set to `user_status_not_confirmed` and a confirmation email will be sent out.
password optional string	New password.
timezone optional string	New timezone.
post_pref optional string	Posting preference, `user_postpref_html`, `user_postpref_plain`, `user_postpref_markdown`
per_page_pref optional string	Per page display preference, `user_per_page_pref20`, `user_per_page_pref50`, `user_per_page_pref100`, `user_per_page_pref_infinite`
time_pref optional string	How to display times, `standard_time`, `military_time`
date_pref optional string	How to display dates, `us_date`, `iso_date`, `international_date`
dont_munge_message_id optional boolean	Whether to change the message-id of any posted messages. In the user interface, this is the "I always want copies of my own emails" checkbox.
allow_facebook_login optional boolean	Allow login to your account via Facebook.
allow_google_login optional boolean	Allow login to your account via Google.
allow_sso_login optional boolean	Allow login to your account via Single Sign On.
monday_start optional boolean	If the calendar should start on Monday (defaults to Sunday).

Returns

Returns the user object if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid email address). Below are the unique errors to this call.

Additional Errors

bad_request	"same email" is returned if the new email address is the same as the old email address.
bad_request	"invalid email" is returned if the new email address is invalid.
bad_request	"email exists" is returned if the new email address already exists.
bad_request	"password too short" is returend if the password is too short.

Notes

If the email address of the user has changed, a new authentication cookie will be set.

POST /api/v1/updateuser

$ curl "https://groups.io/api/v1/updateuser" \
-b "cookies.curl" \
-d email=test@example.com \
-d csrf=12345

Example Successful Response:View User definition

 {
 "id": 59,
 "object": "user",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "email": "user@example.com",
 "full_name": "",
 "user_name": "",
 "timezone": "",
 "status": "user_status_bounced",
 "profile_photo_url": "",
 "post_pref": "",
 "per_page_pref": "",
 "allow_facebook_login": false,
 "allow_google_login": false,
 "allow_sso_login": false,
 "csrf_token": "",
 "two_factor_enabled": false,
 "recovery_codes": "",
 "dont_munge_message_id": false,
 "about_me": "",
 "about_format": "",
 "location": "",
 "website": "",
 "time_pref": "",
 "date_pref": "",
 "monday_start": false,
 "profile_privacy": "",
 "default_message_view": "expanded_message_view",
 "topics_sort_dir": "",
 "topic_sort_dir": "",
 "messages_sort_dir": "",
 "expanded_messages_sort_dir": "",
 "search_sort": "",
 "search_sort_dir": "",
 "photos_order_by": "",
 "photos_sort_dir": "",
 "album_order_by": "",
 "album_sort_dir": "",
 "home_page": "",
 "subscriptions": [
   {
    "id": 14,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 96,
    "group_id": 52,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 64,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 88,
    "pending_subs": 37,
    "pending_msgs": 0,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Profile#

Updates the authenticated user's profile.

POST Parameters

csrf required string	The `csrf_token` from the user object returned when first logged in.
member_info_id optional integer	To change the profile information for just one subscription, supply the member_info_id of that subscription.
full_name optional string	Your name.
user_name optional string	Your user name. Only applicable when `member_info_id` is not specified.
about_me optional string	Your about me section, in HTML format.
location optional string	Your location.
website optional string	Your website.
profile_privacy optional string	Your profile privacy setting. Can be: `profile_private`, `profile_members`, `profile_public`

Returns

Returns the user object if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid member_info_id). Below are the unique errors to this call.

Additional Errors

bad_request	"invalid member_info_id" is returned if the provided member_info_id is incorrect.
bad_request	"invalid profile_privacy" is returned if the provided profile_privacy is incorrect.

POST /api/v1/updateprofile

$ curl "https://groups.io/api/v1/updateprofile" \
-b "cookies.curl" \
-d full_name=Joe+Smith \
-d "csrf=12345"

Example Successful Response:View User definition

 {
 "id": 92,
 "object": "user",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "email": "user@example.com",
 "full_name": "",
 "user_name": "",
 "timezone": "",
 "status": "user_status_bounced",
 "profile_photo_url": "",
 "post_pref": "",
 "per_page_pref": "",
 "allow_facebook_login": false,
 "allow_google_login": false,
 "allow_sso_login": false,
 "csrf_token": "",
 "two_factor_enabled": false,
 "recovery_codes": "",
 "dont_munge_message_id": false,
 "about_me": "",
 "about_format": "",
 "location": "",
 "website": "",
 "time_pref": "",
 "date_pref": "",
 "monday_start": false,
 "profile_privacy": "",
 "default_message_view": "expanded_message_view",
 "topics_sort_dir": "",
 "topic_sort_dir": "",
 "messages_sort_dir": "",
 "expanded_messages_sort_dir": "",
 "search_sort": "",
 "search_sort_dir": "",
 "photos_order_by": "",
 "photos_sort_dir": "",
 "album_order_by": "",
 "album_sort_dir": "",
 "home_page": "",
 "subscriptions": [
   {
    "id": 38,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 95,
    "group_id": 97,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 44,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 78,
    "pending_subs": 8,
    "pending_msgs": 27,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Profile Photo#

Updates the authenticated user's profile photo.

POST Parameters

csrf required string	The `csrf_token` from the user object returned when first logged in.
imageupload required multipart file	Multipart file upload of a new profile photo. The photo can be in GIF or JPEG format.
member_info_id optional integer	To change the profile photo for just one subscription, supply the member_info_id of that subscription.

Returns

Returns the user object if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid member_info_id). Below are the unique errors to this call.

Additional Errors

bad_request	"invalid member_info_id" is returned if the provided member_info_id is incorrect.

POST /api/v1/updateprofilephoto

$ curl "https://groups.io/api/v1/updateprofilephoto" \
-b "cookies.curl" \
-F fileupload=@path_to_profile_photo \
-F "csrf=12345"

Example Successful Response:View User definition

 {
 "id": 63,
 "object": "user",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "email": "user@example.com",
 "full_name": "",
 "user_name": "",
 "timezone": "",
 "status": "user_status_bounced",
 "profile_photo_url": "",
 "post_pref": "",
 "per_page_pref": "",
 "allow_facebook_login": false,
 "allow_google_login": false,
 "allow_sso_login": false,
 "csrf_token": "",
 "two_factor_enabled": false,
 "recovery_codes": "",
 "dont_munge_message_id": false,
 "about_me": "",
 "about_format": "",
 "location": "",
 "website": "",
 "time_pref": "",
 "date_pref": "",
 "monday_start": false,
 "profile_privacy": "",
 "default_message_view": "expanded_message_view",
 "topics_sort_dir": "",
 "topic_sort_dir": "",
 "messages_sort_dir": "",
 "expanded_messages_sort_dir": "",
 "search_sort": "",
 "search_sort_dir": "",
 "photos_order_by": "",
 "photos_sort_dir": "",
 "album_order_by": "",
 "album_sort_dir": "",
 "home_page": "",
 "subscriptions": [
   {
    "id": 54,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 52,
    "group_id": 11,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 1,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 38,
    "pending_subs": 72,
    "pending_msgs": 88,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Profile Photo#

Deletes the authenticated user's profile photo.

POST Parameters

csrf required string	The `csrf_token` from the user object returned when first logged in.
member_info_id optional integer	To delete the profile photo for just one subscription, supply the member_info_id of that subscription.

Returns

Returns the user object if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid member_info_id). Below are the unique errors to this call.

Additional Errors

bad_request	"invalid member_info_id" is returned if the provided member_info_id is incorrect.

POST /api/v1/deleteprofilephoto

$ curl "https://groups.io/api/v1/deleteprofilephoto" \
-b "cookies.curl" \
-d "csrf=12345"

Example Successful Response:View User definition

 {
 "id": 80,
 "object": "user",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "email": "user@example.com",
 "full_name": "",
 "user_name": "",
 "timezone": "",
 "status": "user_status_bounced",
 "profile_photo_url": "",
 "post_pref": "",
 "per_page_pref": "",
 "allow_facebook_login": false,
 "allow_google_login": false,
 "allow_sso_login": false,
 "csrf_token": "",
 "two_factor_enabled": false,
 "recovery_codes": "",
 "dont_munge_message_id": false,
 "about_me": "",
 "about_format": "",
 "location": "",
 "website": "",
 "time_pref": "",
 "date_pref": "",
 "monday_start": false,
 "profile_privacy": "",
 "default_message_view": "expanded_message_view",
 "topics_sort_dir": "",
 "topic_sort_dir": "",
 "messages_sort_dir": "",
 "expanded_messages_sort_dir": "",
 "search_sort": "",
 "search_sort_dir": "",
 "photos_order_by": "",
 "photos_sort_dir": "",
 "album_order_by": "",
 "album_sort_dir": "",
 "home_page": "",
 "subscriptions": [
   {
    "id": 41,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 71,
    "group_id": 41,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 14,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 27,
    "pending_subs": 36,
    "pending_msgs": 38,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Subscription#

Get a subscription to a single group.

Query Parameters

group_id required integer	ID of the group.

Returns

Returns a member info object if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid parameter). Below are the unique errors to this call.

GET /api/v1/getsub

$ curl "https://groups.io/api/v1/getsub?group_id=2" \
-b "cookies.curl"

Example Successful Response:View Member Info definition

 {
 "id": 84,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 44,
 "group_id": 37,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 98,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 23,
 "pending_subs": 94,
 "pending_msgs": 95,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Subscriptions#

Get the subscriptions associated with the logged in user. Subscriptions are returned using the pagination request and object format.

Query Parameters

limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `full_name`, `email`, `delivery`, `joined`.
sort_dir optional string	Sort direction. Can be `asc` or .

Returns

Returns a member info list object if successful. Returns an error if parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

GET /api/v1/getsubs

$ curl "https://groups.io/api/v1/getsubs?limit=2&page_token=1" \
-b "cookies.curl"

Example Successful Response:View Member Info List definition

 {
 "object": "list",
 "total_count": 62,
 "start_item": 35,
 "end_item": 79,
 "has_more": false,
 "next_page_token": 7,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 28,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 82,
    "group_id": 95,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 56,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 78,
    "pending_subs": 89,
    "pending_msgs": 72,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Update Subscription#

Updates a subscription by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

POST Parameters

member_info_id required integer	ID of the member info object.
csrf required string	The `csrf_token` from the user object returned when first logged in.
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
signature optional string	Signature to be used for signing messages.
sig_format optional string	Format of the signature, can be `sig_format_html`, `sig_format_markdown`, `sig_format_plain`. Ignored if `signature` is also not specified.
use_signature optional boolean	Whether to use the signature for posts originating from the Groups.io website.
use_signature_email optional boolean	Whether to use the signature for posts originated from email.
The following are ignored if the subscription `mod_status` is `mod_status_none`.
pending_msg_notify optional string	Notify about pending messages, can be `sub_notify_email`, `sub_notify_none`
pending_sub_notify optional string	Notify about pending subscriptions, can be `sub_notify_email`, `sub_notify_none`
sub_notify optional string	Notify when someone joins the group, can be `sub_notify_email`, `sub_notify_none`
storage_notify optional string	Notify when storage limits are reached, can be `sub_notify_email`, `sub_notify_none`
sub_group_notify optional string	Notify when a subgroup is created, can be `sub_notify_email`, `sub_notify_none`
message_report_notify optional string	Notify when someone reports a message, can be `sub_notify_email`, `sub_notify_none`
owner_msg_notify optional string	Receive messages sent to the +owner address, can be `sub_ownermsg_notify_all`, `sub_ownermsg_notify_subs`, `sub_ownermsg_notify_none`

Returns

Returns a member info object if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid parameter). Below are the unique errors to this call.

Additional Errors

Notes

If email_delivery is switched from either email_delivery_digest or email_delivery_html_digest to one of the non-digest options, and there are pending digest messages, a digest will be generated at this time.

GET /api/v1/updatesub

$ curl "https://groups.io/api/v1/updatesub" \
-b "cookies.curl" \
-d member_info_id=2 \
-d email_delivery=email_delivery_single \
-d csrf=12345

Example Successful Response:View Member Info definition

 {
 "id": 41,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 15,
 "group_id": 2,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 64,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 20,
 "pending_subs": 89,
 "pending_msgs": 3,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Delete Subscription#

Delete a subscription.

POST Parameters

group_id required	ID of the group from which you wish to unsubscribe.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns an error if update parameters are invalid (e.g. specifying an invalid group name). Below are the unique errors to this call.

Additional Errors

bad_request	"you are the only owner" is returned if you are the only owner of the group.

Notes

Every group must have at least one owner. If you are the only owner of the group, you cannot delete your subscription.

POST /api/v1/deletesub

$ curl "https://groups.io/api/v1/deletesub" \
-b "cookies.curl" \
-d group_id=2 \
-d csrf=12345

Successful Response

HTTP 200

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Webhooks

Webhooks allow you to be notified whenever a change occurs to a group that you are an owner of. The groups.io service will send a webhook event object to a URL that you specify whenever an event you are interested in occurs.

TODO:

Explain retry/backoff strategy
Explain HTTP error codes that you should return to us

Register Webhook Subscription#

Permissions Needed

You must be an owner of the group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.

Returns

Returns a webhook subscription object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.

POST /api/v1/registersubscription

$ curl "https://groups.io/api/v1/registersubscription" \
-b "cookies.curl" \
-d group_id=12&csrf=1234

Example Successful Response:View Webhook Subscription definition

 {
 "object": "webhook_subscription",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "url": "https://example.com/webhook",
 "secret": "blahblahblah",
 "group_ids": 4,
 "include_subgroups": false,
 "actions": ["created_subgroup"],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Wikis

These are the API endpoints for wikis.

Get Wiki Pages#

Get a list of all wiki pages. Pages are returned using the pagination request and object format.

Permissions Needed

You must have the view_wiki permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are: `title`, `created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.

Returns

Returns an wiki page list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/getwikipages

$ curl "https://groups.io/api/v1/getwikipages?group_id=12" \
-b "cookies.curl"

Example Successful Response:View Wiki Page List definition

 {
 "object": "list",
 "total_count": 0,
 "start_item": 60,
 "end_item": 79,
 "has_more": false,
 "next_page_token": 87,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 15,
    "object": "wiki_page",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 85,
    "group_id": 98,
    "title": "",
    "path": "",
    "locked": false,
    "rev_count": 63,
   }
 ],
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

New Wiki Page#

Create a new wiki page. The wiki page is created.

Permissions Needed

You must have the manage_wiki permission to use this call with a group.

POST Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
title required string	The title of the wiki page.
body required string	The body of the wiki page, in HTML format.
locked optional boolean	If the page should be locked.
edit_msg optional string	An edit message.
csrf required string	The `csrf_token` from the user object returned when first logged in.

Returns

Returns a chat object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call.

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid title" is returned if the title is missing or invalid.
"bad_request"	"invalid body" is returned if the body is missing or invalid.
"bad_request"	"duplicate title" is returned if the title is a duplicate of another wiki page.

POST /api/v1/newwikipage

$ curl "https://groups.io/api/v1/newwikipage" \
-b "cookies.curl" \
-d group_id=12&title=Test&body=testing&csrf=1234

Example Successful Response:View Wiki Page Set definition

 {
 "page": 
   {
    "id": 25,
    "object": "wiki_page",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 53,
    "group_id": 51,
    "title": "",
    "path": "",
    "locked": false,
    "rev_count": 80,
   },
 "data": 
   {
    "id": 32,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 62,
    "group_id": 32,
    "page_id": 58,
    "body": "",
    "edit_msg": "",
   },
 "sidebar": 
   {
    "id": 64,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 38,
    "group_id": 49,
    "page_id": 88,
    "body": "",
    "edit_msg": "",
   },
 "footer": 
   {
    "id": 9,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 16,
    "group_id": 56,
    "page_id": 87,
    "body": "",
    "edit_msg": "",
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Get Wiki Page Set#

Get wiki page set.

Permissions Needed

You must have the view_wiki permission to use this call with a group.

Query Parameters

group_id required integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name required string	Name of the group. Either `group_id` or `group_name` must be specified.
path required string	Path of wiki page.

Returns

Returns a wiki_page_set object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

GET /api/v1/getwikipageset

$ curl "https://groups.io/api/v1/getfile?group_id=12&path=test" \
-b "cookies.curl"

Example Successful Response:View Wiki Page Set definition

 {
 "page": 
   {
    "id": 72,
    "object": "wiki_page",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 8,
    "group_id": 44,
    "title": "",
    "path": "",
    "locked": false,
    "rev_count": 33,
   },
 "data": 
   {
    "id": 46,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 43,
    "group_id": 1,
    "page_id": 73,
    "body": "",
    "edit_msg": "",
   },
 "sidebar": 
   {
    "id": 44,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 5,
    "group_id": 0,
    "page_id": 6,
    "body": "",
    "edit_msg": "",
   },
 "footer": 
   {
    "id": 55,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 63,
    "group_id": 78,
    "page_id": 91,
    "body": "",
    "edit_msg": "",
   },
}

Example Error Response

 {
     "object": "error",
     "type": "inadequate_permissions",
     "extra": ""
 }

Objects

Calls can return an object, or a list of objects, which can be paged through. Every object has an object parameter which identifies the object. Lists of objects also have an object parameter, set to list.

The Add Error Object#

The direct add results error object.

Response Attributes

object string	direct_add_error.
email string
status string	utils.DirectAddStatus.
group_id integer

Example Response

{
 "object": "direct_add_error",
 "email": "",
 "status": "",
 "group_id": 61,
}

The Album Object#

The album object.

Response Attributes

id integer	Unique ID of the album object.
object string	album.
created string date-time
updated string date-time
user_id integer
group_id integer
upload_perms string
title string	Title of the album.
desc string	Description of the album in plain text.
cover_photo_thumbnail_url string	Thumbnail of cover photo.
cover_photo_url string	Photo to display.
total_photos number	How many photos in album.

Methods That Use This Object

New Photo Album	View Method
Update Photo Album	View Method
Update Photo	View Method

Example Response

{
 "id": 40,
 "object": "album",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 12,
 "group_id": 78,
 "upload_perms": "",
 "title": "",
 "desc": "",
 "cover_photo_thumbnail_url": "",
 "cover_photo_url": "",
 "total_photos": 44,
}

The Album List Object#

Album List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Album objects

Methods That Use This Object

Get Photo Albums	View Method

Example Response

{
 "object": "list",
 "total_count": 36,
 "start_item": 12,
 "end_item": 83,
 "has_more": false,
 "next_page_token": 11,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 35,
    "object": "album",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 71,
    "group_id": 99,
    "upload_perms": "",
    "title": "",
    "desc": "",
    "cover_photo_thumbnail_url": "",
    "cover_photo_url": "",
    "total_photos": 58,
   }
 ],
}

The Attachment Object#

The Attachment object contains all the data required for displaying an image attachment.

Response Attributes

id string
object string	attachment.
created string date-time
group_id integer
user_id integer	Who originally created this table.
thread_id integer
message_num number
attach_num number
type string
sub_type string
name string
content string
image_width number
image_height number
thumbnail_url string

Example Response

{
 "id": "",
 "object": "attachment",
 "created": "2009-11-10T15:00:00-08:00",
 "group_id": 4,
 "user_id": 1,
 "thread_id": 83,
 "message_num": 16,
 "attach_num": 81,
 "type": "",
 "sub_type": "",
 "name": "",
 "content": "",
 "image_width": 96,
 "image_height": 56,
 "thumbnail_url": "",
}

The Chat Object#

The chat object.

Response Attributes

id integer	Unique ID of the chat object.
object string	chat.
created string date-time
updated string date-time
user_id integer	ID of the person who created the chat.
profile_photo_url string	If not empty then there is a profile photo associated with this author.
name string	Name of the person who created the chat.
can_view_profile boolean	If the person viewing this chat can view the creator's profile.
group_id integer	ID of the group the chat is in.
subject string
desc string
is_closed boolean
num_messages number
chat_sub optional Chat Sub object	If the calling person is subscribed to this chat, this is their subscription.

Methods That Use This Object

New Chat	View Method
Update Chat	View Method

Example Response

{
 "id": 89,
 "object": "chat",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 16,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "group_id": 17,
 "subject": "The chat subject",
 "desc": "This is the description of the chat",
 "is_closed": false,
 "num_messages": 74,
 "chat_sub": 
   {
    "id": 77,
    "object": "chat_sub",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 3,
    "group_id": 66,
    "chat_id": 61,
    "last_msg_seen": 84,
   },
}

The Chat List Object#

Chat List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Chat objects

Methods That Use This Object

Get Chats	View Method

Example Response

{
 "object": "list",
 "total_count": 23,
 "start_item": 29,
 "end_item": 11,
 "has_more": false,
 "next_page_token": 83,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 4,
    "object": "chat",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 50,
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
    "group_id": 62,
    "subject": "The chat subject",
    "desc": "This is the description of the chat",
    "is_closed": false,
    "num_messages": 91,
    "chat_sub": 
      {
       "id": 47,
       "object": "chat_sub",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 10,
       "group_id": 37,
       "chat_id": 64,
       "last_msg_seen": 73,
      },
   }
 ],
}

The Chat Message Object#

The chat message object. A chat message is a posted message to a chat room.

Response Attributes

id integer	Unique ID of the chat_message object.
object string	chat_message.
created string date-time
version number	The version of this object. Used to detect server upgrades to force reload of the app. The current version is 2.
user_id integer	ID of the person who is subscribed.
group_id integer	ID of the group the chat is in.
chat_id integer	ID of the chat.
type string	Type of message. Can be one of: `chat_msg_type_closed`, `chat_msg_type_first`, `chat_msg_type_joined`, `chat_msg_type_left`, `chat_msg_type_normal`.
message string	The chat message itself (dependant on the Type of chat message), in HTML format.
msg_num number	The message number, increases monotonically from 1.
display_name string
user_name string
profile_photo_url string
profile_privacy string	Privacy setting of the sender of the message.
email string	Possibly obscured, depending on group settings.

Example Response

{
 "id": 57,
 "object": "chat_message",
 "created": "2009-11-10T15:00:00-08:00",
 "version": 3,
 "user_id": 81,
 "group_id": 38,
 "chat_id": 17,
 "type": "chat_msg_type_closed",
 "message": "",
 "msg_num": 64,
 "display_name": "",
 "user_name": "",
 "profile_photo_url": "",
 "profile_privacy": "",
 "email": "",
}

The Chat Message List Object#

Chat Message List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Chat Message objects

Methods That Use This Object

Get Chat History	View Method

Example Response

{
 "object": "list",
 "total_count": 76,
 "start_item": 66,
 "end_item": 35,
 "has_more": false,
 "next_page_token": 5,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 85,
    "object": "chat_message",
    "created": "2009-11-10T15:00:00-08:00",
    "version": 5,
    "user_id": 79,
    "group_id": 41,
    "chat_id": 63,
    "type": "chat_msg_type_closed",
    "message": "",
    "msg_num": 4,
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
   }
 ],
}

The Chat Post Object#

The chat post object. A chat post is the object a client sends to the server containing a message to post to the chat room. It then gets turned into a chat_message and is sent out to every person currently in the chat room, as well as stored in the database. Note that these messages should be in Markdown format and can contain emoji codes. They are converted on the server and returned as HTML in chat_message objects. In addition to posts, commands can be sent. Currently, only the /leave command is supported.

Response Attributes

object string	chat_post.
type string	Type of message. This should be set to `chat_post_type_post`.
message string	The chat message itself (dependant on the Type of chat message), in Markdown format.

Example Response

{
 "object": "chat_post",
 "type": "chat_post_type_post",
 "message": "Did you hear the news?",
}

The Chat Sub Object#

The chat subscription object.

Response Attributes

id integer	Unique ID of the draft object.
object string	chat_sub.
created string date-time
updated string date-time
user_id integer	ID of the person who is subscribed.
group_id integer	ID of the group the chat is in.
chat_id integer	ID of the chat.
last_msg_seen number	ID of the last chat_message msg_num seen by this subscriber.

Methods That Use This Object

Join Chat	View Method

Example Response

{
 "id": 19,
 "object": "chat_sub",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 47,
 "group_id": 83,
 "chat_id": 36,
 "last_msg_seen": 10,
}

The Database Column Object#

The database column object.

Response Attributes

id integer	Column ID.
name string	Name is the name of the column.
type string	Type is the column type.
required boolean	Required means that the field cannot be empty.
color string	Color is the color of the row.
choices optional array of string	Choices are the titles of choices for Multiple Choice column. Also used for YesNo.
width number	Width is the width of the column (0 means not set/use the default).

Example Response

{
 "id": 3,
 "name": "",
 "type": "",
 "required": false,
 "color": "",
 "choices": [""],
 "width": 30,
}

The Database Table Object#

The database table object.

Response Attributes

id integer
object string	databasetable.
created string date-time
updated string date-time
group_id integer
user_id integer	Who originally created this table.
name string	Name of table.
short_desc string
desc string
desc_type string	html, plain, markdown.
edit_table string
edit_rows string
add_rows string
view_table string
num_rows number	Number of rows, not maintained automatically.
max_row_id integer	For setting DatabaseRow.RowID, not maintained automatically.
num_columns number	Number of columns, automatically maintained.
max_col_id integer	For setting unique column ids.
display_template string	Display template.
columns array of Database Column objects

Example Response

{
 "id": 47,
 "object": "databasetable",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 7,
 "user_id": 72,
 "name": "",
 "short_desc": "",
 "desc": "",
 "desc_type": "",
 "edit_table": "",
 "edit_rows": "",
 "add_rows": "",
 "view_table": "",
 "num_rows": 4,
 "max_row_id": 98,
 "num_columns": 91,
 "max_col_id": 25,
 "display_template": "",
 "columns": [
   {
    "id": 37,
    "name": "",
    "type": "",
    "required": false,
    "color": "",
    "choices": [""],
    "width": 72,
   }
 ],
}

The Direct Add Results Object#

The direct add results object.

Response Attributes

object string	direct_add_results.
total_emails number
errors array of Add Error objects
added_members array of Member Info objects

Methods That Use This Object

Direct Add	View Method
Send Invites	View Method

Example Response

{
 "object": "direct_add_results",
 "total_emails": 43,
 "errors": [
   {
    "object": "direct_add_error",
    "email": "",
    "status": "",
    "group_id": 29,
   }
 ],
 "added_members": [
   {
    "id": 4,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 14,
    "group_id": 89,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 18,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 92,
    "pending_subs": 58,
    "pending_msgs": 50,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

The Draft Object#

The draft object. Draft represents a draft of a posting (a post in process of being written).

Response Attributes

id integer	Unique ID of the draft object.
object string	draft.
created string date-time
updated string date-time
user_id integer	ID of the user who created the draft.
group_id integer	ID of the group the draft was created in.
draft_type string	The type of message this draft represents.
subject string	Subject of the draft message.
body string	Body of the draft message.
body_type string	Body type of the draft message.
is_special boolean	If the draft should be sent as a special message. Only applicable for `draft_type_post` and `draft_type_reply`.
num_attachments number	The number of attachments associated with the draft.
next_attachment_id integer	The ID of the next attachment to be uploaded.
message_id integer	message_id is for replies, and is the ID of the Message we're replying to.
bcc_me boolean	If we should BCC ourselves with the message. Only applicable for `draft_type_post_to_sub`.
bcc_all boolean	If we should BCC all moderators with the message. Only applicable for `draft_type_post_to_sub`.

Methods That Use This Object

New Draft	View Method
Update Draft	View Method

Example Response

{
 "id": 80,
 "object": "draft",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 78,
 "group_id": 17,
 "draft_type": "",
 "subject": "",
 "body": "",
 "body_type": "",
 "is_special": false,
 "num_attachments": 25,
 "next_attachment_id": 13,
 "message_id": 69,
 "bcc_me": false,
 "bcc_all": false,
}

The Draft Attachment Object#

The draft attachment object. This represents an attachment associated with a draft.

Response Attributes

id integer	ID of the draft attachment object.
object string	draft_attachment.
draft_id integer	ID of the draft this attachment is associated with.
url string	The URL of the draft attachment, for displaying the attachment.
filename string	Filename of the attachment.
size number	Size of the attachment.
content_type string	Content type of the attachment.
inline boolean	If the attachment represents an inline image.

Example Response

{
 "id": 35,
 "object": "draft_attachment",
 "draft_id": 10,
 "url": "",
 "filename": "",
 "size": 52,
 "content_type": "",
 "inline": false,
}

The Draft Attachment List Object#

Draft Attachment List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Draft Attachment objects

Methods That Use This Object

Upload Attachments	View Method
Get Attachments	View Method

Example Response

{
 "object": "list",
 "total_count": 71,
 "start_item": 72,
 "end_item": 9,
 "has_more": false,
 "next_page_token": 76,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 87,
    "object": "draft_attachment",
    "draft_id": 88,
    "url": "",
    "filename": "",
    "size": 46,
    "content_type": "",
    "inline": false,
   }
 ],
}

The Draft List Object#

Draft List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Draft objects

Methods That Use This Object

Get Drafts	View Method

Example Response

{
 "object": "list",
 "total_count": 18,
 "start_item": 33,
 "end_item": 18,
 "has_more": false,
 "next_page_token": 83,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 66,
    "object": "draft",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 93,
    "group_id": 74,
    "draft_type": "",
    "subject": "",
    "body": "",
    "body_type": "",
    "is_special": false,
    "num_attachments": 21,
    "next_attachment_id": 73,
    "message_id": 48,
    "bcc_me": false,
    "bcc_all": false,
   }
 ],
}

The Error Object#

The error object.

Response Attributes

object string	error.
type string
extra string

Example Response

{
 "object": "error",
 "type": "",
 "extra": "",
}

The Event Object#

The event object.

Response Attributes

id integer	Unique ID of the rsvp object.
object string	event.
created string date-time	The time that this object was created.
updated string date-time	The time that this object was last updated.
creator_name string	Name of the person who created this event.
group_id integer	The ID of the associated group.
group_name string	Name of the associated group.
nice_group_name string	Nice version of the group name.
start_time string date-time	Start time of event.
end_time string date-time	End time of event.
timezone string	Timezone that event was created in.
all_day boolean	If event is all day.
name string	Name of the event.
location string	Location of the event.
description string	Event description, in HTML format.
organizer_name string	Organizer name.
organizer_email string	Organizer email.
organizer_phone string	Organizer phone number.
color_name string	Name of the event color. Can be one of: `tag_antique_pink`, `tag_apricot`, `tag_aquamute`, `tag_beige`, `tag_bluejean`, `tag_blush`, `tag_burnt_yellow`, `tag_capri_blue`, `tag_cerulean_blue`, `tag_cherry_blossom`, `tag_cloudy_blue`, `tag_cucumber`, `tag_dark_grey`, `tag_dark_orange`, `tag_dusty_mauve`, `tag_emerald_green`, `tag_grape`, `tag_green_lantern`, `tag_green_sage`, `tag_grey_blue`, `tag_light_brown`, `tag_light_grey`, `tag_light_lilac`, `tag_lilac`, `tag_lips`, `tag_melon`, `tag_military`, `tag_moss_green`, `tag_mulbery`, `tag_mustard`, `tag_orange`, `tag_orchid`, `tag_peony`, `tag_pink`, `tag_purple`, `tag_purple_blue`, `tag_purple_grey`, `tag_sage`, `tag_sky`, `tag_terracotta`, `tag_tomato`, `tag_yellow`.
color_hex string	Hex value of the event color.
rsvp boolean	Requesting an RSVP.
max_attendees number	Number of attendees for RSVP events (0 if unlimited).
additional_guests boolean	Whether attendees can bring additional people.
comment_label string	If additional information is requested, this is the label for that field.
yes_message string	Email to send when people RSVP Yes, in same format as Format.
has_rsvp boolean	If there is an RSVP record for this event corresponding to this user.
rsvp_type string	Type of RSVP.
rsvp_comment string	Any comment left with the RSVP.
rsvp_additional_guests number	Number of additional guests specified by the RSVP.

Methods That Use This Object

Get Event	View Method

Example Response

{
 "id": 46,
 "object": "event",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "creator_name": "@JohnSmith",
 "group_id": 4,
 "group_name": "",
 "nice_group_name": "",
 "start_time": "2009-11-10T15:00:00-08:00",
 "end_time": "2009-11-10T15:00:00-08:00",
 "timezone": "",
 "all_day": false,
 "name": "",
 "location": "",
 "description": "",
 "organizer_name": "",
 "organizer_email": "",
 "organizer_phone": "",
 "color_name": "tag_antique_pink",
 "color_hex": "",
 "rsvp": false,
 "max_attendees": 54,
 "additional_guests": false,
 "comment_label": "",
 "yes_message": "",
 "has_rsvp": false,
 "rsvp_type": "",
 "rsvp_comment": "",
 "rsvp_additional_guests": 63,
}

The Event List Object#

The Event List object contains a list of Event objects.

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Event objects

Methods That Use This Object

Get Events	View Method

Example Response

{
 "object": "list",
 "total_count": 60,
 "start_item": 91,
 "end_item": 59,
 "has_more": false,
 "next_page_token": 32,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 97,
    "object": "event",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "creator_name": "@JohnSmith",
    "group_id": 99,
    "group_name": "",
    "nice_group_name": "",
    "start_time": "2009-11-10T15:00:00-08:00",
    "end_time": "2009-11-10T15:00:00-08:00",
    "timezone": "",
    "all_day": false,
    "name": "",
    "location": "",
    "description": "",
    "organizer_name": "",
    "organizer_email": "",
    "organizer_phone": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "rsvp": false,
    "max_attendees": 19,
    "additional_guests": false,
    "comment_label": "",
    "yes_message": "",
    "has_rsvp": false,
    "rsvp_type": "",
    "rsvp_comment": "",
    "rsvp_additional_guests": 99,
   }
 ],
}

The Feed Object#

The Feed object contains all the data required for displaying one group in a user's feed page.

Response Attributes

object string	feed.
member_info Member Info object
group Group object
topics optional array of Feed Topic objects	The five most recent topics.
events optional array of Event objects	The next four upcoming events.
files optional array of File objects	The five most recent file uploads.
photos optional array of Photo objects	The nine most recent photo uploads.
chats optional array of Chat objects	The five most recent chats.
wikis optional array of Wiki Page objects	The five most recently updated wiki pages.
subgroups optional array of Group objects	The five newest subgroups, if this is a parent group.
tables optional array of Database Table objects	The five most recently updated database tables.
hashtags optional array of Hashtag objects	The ten most popular hashtags.

Example Response

{
 "object": "feed",
 "member_info": 
   {
    "id": 25,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 83,
    "group_id": 78,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 30,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 57,
    "pending_subs": 17,
    "pending_msgs": 2,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
 "group": 
   {
    "id": 22,
    "object": "group",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "title": "The Example Group",
    "name": "example",
    "nice_group_name": "",
    "alias": "",
    "desc": "This is the description for the example group.",
    "plain_desc": "This is the description for the example group.",
    "subject_tag": "[example]",
    "footer": "",
    "website": "",
    "announce": false,
    "moderated": false,
    "new_users_moderated": false,
    "unmoderate_users_after": 31,
    "restricted": false,
    "allow_non_subs_to_post": false,
    "force_html_emails": false,
    "normalize_html_emails": false,
    "reply_to": "group_reply_only_to_sender",
    "remove_other_reply_options": false,
    "privacy": "group_privacy_archives",
    "seperate_footers": false,
    "allow_downloads": "allow_downloads_by_members",
    "members_visible": "group_view_members_moderators",
    "subgroup_access": "sub_group_moderators",
    "calendar_access": "group_access_limited",
    "files_access": "group_access_limited",
    "database_access": "group_access_limited",
    "wiki_access": "group_access_limited",
    "photos_access": "group_access_limited",
    "member_directory_access": "group_access_limited",
    "polls_access": "polls_access_limited",
    "chat_access": "group_access_limited",
    "handle_attachments": "group_attachments_bounced",
    "plain_text_only": false,
    "handle_virus": "handle_virus_block",
    "locked": false,
    "has_cover_photo": false,
    "has_icon": false,
    "parent_group_id": 72,
    "org_id": 28,
    "max_photo_size_email": "max_photo_size_ex_small",
    "max_photo_size_photos": "max_photo_size_ex_small",
    "max_photo_size_databases": "max_photo_size_ex_small",
    "max_photo_size_wiki_images": "max_photo_size_ex_small",
    "hash_tags_required": false,
    "hash_tag_permissions": "hash_tag_create_mods_bounce",
    "bounce_attachments": false,
    "allow_photos_in_files": false,
    "allow_reposts": false,
    "min_days_between_reposts": 82,
    "max_number_of_reposts": 5,
    "email_delivery_default": "email_delivery_digest",
    "message_selection_default": "message_selection_all",
    "auto_follow_replies_default": false,
    "max_attachment_size_default": "max_attachment_size_large",
    "default_timezone": "",
    "default_time_pref": "military_time",
    "default_date_pref": "international_date",
    "default_monday_start": false,
    "disable_edits": false,
    "disable_no_email": false,
    "auto_close_threads": false,
    "close_threads_after": 18,
    "auto_moderate_threads": false,
    "moderate_threads_after": 85,
    "subgroupcategoryid": 93,
    "subs_count": 48,
    "pending_subs_count": 25,
    "pending_msgs_count": 16,
    "open_chats_count": 71,
    "threads_count": 15,
    "messages_count": 76,
    "org_domain": "",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "cover_photo_url": "",
    "icon_url": "",
    "group_url": "",
    "allow_parent_subs_to_post": false,
    "send_event_summaries": false,
    "event_summary_schedule": "event_summary_monthly",
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
 "topics": [
   {
    "topic": 
      {
       "id": 81,
       "object": "topic",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "group_id": 94,
       "group_subject_tag": "",
       "subject": "",
       "summary": "",
       "name": "",
       "profile_photo_url": "",
       "num_messages": 41,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "2009-11-10T15:00:00-08:00",
       "hashtags": [
         {
          "id": 9,
          "object": "hashtag",
          "created": "2009-11-10T15:00:00-08:00",
          "group_id": 64,
          "name": "",
          "alias": 
            {
            },
          "mods_only_post": false,
          "mods_only_replies": false,
          "no_email": false,
          "moderated": false,
          "special": false,
          "replies_unmoderated": false,
          "locked": false,
          "until": "hash_tag_delete_day",
          "close_instead_of_delete": false,
          "description": "",
          "color_name": "tag_antique_pink",
          "color_hex": "",
          "reply_to": "thread_reply_group_default",
          "topic_count": 58,
          "last_message_date": "2009-11-10T15:00:00-08:00",
         }
       ],
      },
    "images": [
      {
       "id": "",
       "object": "attachment",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 42,
       "user_id": 90,
       "thread_id": 37,
       "message_num": 21,
       "attach_num": 44,
       "type": "",
       "sub_type": "",
       "name": "",
       "content": "",
       "image_width": 11,
       "image_height": 13,
       "thumbnail_url": "",
      }
    ],
   }
 ],
 "events": [
   {
    "id": 24,
    "object": "event",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "creator_name": "@JohnSmith",
    "group_id": 11,
    "group_name": "",
    "nice_group_name": "",
    "start_time": "2009-11-10T15:00:00-08:00",
    "end_time": "2009-11-10T15:00:00-08:00",
    "timezone": "",
    "all_day": false,
    "name": "",
    "location": "",
    "description": "",
    "organizer_name": "",
    "organizer_email": "",
    "organizer_phone": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "rsvp": false,
    "max_attendees": 33,
    "additional_guests": false,
    "comment_label": "",
    "yes_message": "",
    "has_rsvp": false,
    "rsvp_type": "",
    "rsvp_comment": "",
    "rsvp_additional_guests": 42,
   }
 ],
 "files": [
   {
    "id": 82,
    "object": "file",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 18,
    "group_id": 26,
    "name": "",
    "desc": "",
    "size": 70,
    "path": "",
    "parent_folder_id": 70,
    "is_folder": false,
    "count": 62,
    "media_type": "",
    "download_url": "",
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
   }
 ],
 "photos": [
   {
    "id": 85,
    "object": "photo",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 29,
    "group_id": 63,
    "name": "",
    "desc": "",
    "media_type": "image/jpeg",
    "size": 22,
    "attachment_num": 51,
    "width": 57,
    "height": 64,
    "album_id": 82,
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
    "format": "gif",
    "focal_length": 3.2,
    "iso": 52,
    "aperture": 3.2,
    "shutter_speed": 54,
    "taken": 73,
    "make": "",
    "model": "",
    "thumbnail_url": "",
    "download_url": "",
   }
 ],
 "chats": [
   {
    "id": 47,
    "object": "chat",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 29,
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
    "group_id": 85,
    "subject": "The chat subject",
    "desc": "This is the description of the chat",
    "is_closed": false,
    "num_messages": 84,
    "chat_sub": 
      {
       "id": 49,
       "object": "chat_sub",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 59,
       "group_id": 17,
       "chat_id": 96,
       "last_msg_seen": 0,
      },
   }
 ],
 "wikis": [
   {
    "id": 72,
    "object": "wiki_page",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 72,
    "group_id": 70,
    "title": "",
    "path": "",
    "locked": false,
    "rev_count": 98,
   }
 ],
 "subgroups": [
   {
    "id": 93,
    "object": "group",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "title": "The Example Group",
    "name": "example",
    "nice_group_name": "",
    "alias": "",
    "desc": "This is the description for the example group.",
    "plain_desc": "This is the description for the example group.",
    "subject_tag": "[example]",
    "footer": "",
    "website": "",
    "announce": false,
    "moderated": false,
    "new_users_moderated": false,
    "unmoderate_users_after": 9,
    "restricted": false,
    "allow_non_subs_to_post": false,
    "force_html_emails": false,
    "normalize_html_emails": false,
    "reply_to": "group_reply_only_to_sender",
    "remove_other_reply_options": false,
    "privacy": "group_privacy_archives",
    "seperate_footers": false,
    "allow_downloads": "allow_downloads_by_members",
    "members_visible": "group_view_members_moderators",
    "subgroup_access": "sub_group_moderators",
    "calendar_access": "group_access_limited",
    "files_access": "group_access_limited",
    "database_access": "group_access_limited",
    "wiki_access": "group_access_limited",
    "photos_access": "group_access_limited",
    "member_directory_access": "group_access_limited",
    "polls_access": "polls_access_limited",
    "chat_access": "group_access_limited",
    "handle_attachments": "group_attachments_bounced",
    "plain_text_only": false,
    "handle_virus": "handle_virus_block",
    "locked": false,
    "has_cover_photo": false,
    "has_icon": false,
    "parent_group_id": 45,
    "org_id": 34,
    "max_photo_size_email": "max_photo_size_ex_small",
    "max_photo_size_photos": "max_photo_size_ex_small",
    "max_photo_size_databases": "max_photo_size_ex_small",
    "max_photo_size_wiki_images": "max_photo_size_ex_small",
    "hash_tags_required": false,
    "hash_tag_permissions": "hash_tag_create_mods_bounce",
    "bounce_attachments": false,
    "allow_photos_in_files": false,
    "allow_reposts": false,
    "min_days_between_reposts": 42,
    "max_number_of_reposts": 5,
    "email_delivery_default": "email_delivery_digest",
    "message_selection_default": "message_selection_all",
    "auto_follow_replies_default": false,
    "max_attachment_size_default": "max_attachment_size_large",
    "default_timezone": "",
    "default_time_pref": "military_time",
    "default_date_pref": "international_date",
    "default_monday_start": false,
    "disable_edits": false,
    "disable_no_email": false,
    "auto_close_threads": false,
    "close_threads_after": 75,
    "auto_moderate_threads": false,
    "moderate_threads_after": 54,
    "subgroupcategoryid": 91,
    "subs_count": 27,
    "pending_subs_count": 86,
    "pending_msgs_count": 95,
    "open_chats_count": 16,
    "threads_count": 43,
    "messages_count": 42,
    "org_domain": "",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "cover_photo_url": "",
    "icon_url": "",
    "group_url": "",
    "allow_parent_subs_to_post": false,
    "send_event_summaries": false,
    "event_summary_schedule": "event_summary_monthly",
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
 "tables": [
   {
    "id": 10,
    "object": "databasetable",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 55,
    "user_id": 43,
    "name": "",
    "short_desc": "",
    "desc": "",
    "desc_type": "",
    "edit_table": "",
    "edit_rows": "",
    "add_rows": "",
    "view_table": "",
    "num_rows": 3,
    "max_row_id": 17,
    "num_columns": 4,
    "max_col_id": 29,
    "display_template": "",
    "columns": [
      {
       "id": 20,
       "name": "",
       "type": "",
       "required": false,
       "color": "",
       "choices": [""],
       "width": 40,
      }
    ],
   }
 ],
 "hashtags": [
   {
    "id": 37,
    "object": "hashtag",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 82,
    "name": "",
    "alias": 
      {
      },
    "mods_only_post": false,
    "mods_only_replies": false,
    "no_email": false,
    "moderated": false,
    "special": false,
    "replies_unmoderated": false,
    "locked": false,
    "until": "hash_tag_delete_day",
    "close_instead_of_delete": false,
    "description": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "reply_to": "thread_reply_group_default",
    "topic_count": 53,
    "last_message_date": "2009-11-10T15:00:00-08:00",
   }
 ],
}

The Feed List Object#

The Feed List object contains a list of Feed objects.

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Feed objects

Methods That Use This Object

Get Feed	View Method

Example Response

{
 "object": "list",
 "total_count": 40,
 "start_item": 3,
 "end_item": 45,
 "has_more": false,
 "next_page_token": 26,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "feed",
    "member_info": 
      {
       "id": 3,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 92,
       "group_id": 65,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 22,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 2,
       "pending_subs": 92,
       "pending_msgs": 99,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      },
    "group": 
      {
       "id": 88,
       "object": "group",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "title": "The Example Group",
       "name": "example",
       "nice_group_name": "",
       "alias": "",
       "desc": "This is the description for the example group.",
       "plain_desc": "This is the description for the example group.",
       "subject_tag": "[example]",
       "footer": "",
       "website": "",
       "announce": false,
       "moderated": false,
       "new_users_moderated": false,
       "unmoderate_users_after": 81,
       "restricted": false,
       "allow_non_subs_to_post": false,
       "force_html_emails": false,
       "normalize_html_emails": false,
       "reply_to": "group_reply_only_to_sender",
       "remove_other_reply_options": false,
       "privacy": "group_privacy_archives",
       "seperate_footers": false,
       "allow_downloads": "allow_downloads_by_members",
       "members_visible": "group_view_members_moderators",
       "subgroup_access": "sub_group_moderators",
       "calendar_access": "group_access_limited",
       "files_access": "group_access_limited",
       "database_access": "group_access_limited",
       "wiki_access": "group_access_limited",
       "photos_access": "group_access_limited",
       "member_directory_access": "group_access_limited",
       "polls_access": "polls_access_limited",
       "chat_access": "group_access_limited",
       "handle_attachments": "group_attachments_bounced",
       "plain_text_only": false,
       "handle_virus": "handle_virus_block",
       "locked": false,
       "has_cover_photo": false,
       "has_icon": false,
       "parent_group_id": 87,
       "org_id": 38,
       "max_photo_size_email": "max_photo_size_ex_small",
       "max_photo_size_photos": "max_photo_size_ex_small",
       "max_photo_size_databases": "max_photo_size_ex_small",
       "max_photo_size_wiki_images": "max_photo_size_ex_small",
       "hash_tags_required": false,
       "hash_tag_permissions": "hash_tag_create_mods_bounce",
       "bounce_attachments": false,
       "allow_photos_in_files": false,
       "allow_reposts": false,
       "min_days_between_reposts": 84,
       "max_number_of_reposts": 6,
       "email_delivery_default": "email_delivery_digest",
       "message_selection_default": "message_selection_all",
       "auto_follow_replies_default": false,
       "max_attachment_size_default": "max_attachment_size_large",
       "default_timezone": "",
       "default_time_pref": "military_time",
       "default_date_pref": "international_date",
       "default_monday_start": false,
       "disable_edits": false,
       "disable_no_email": false,
       "auto_close_threads": false,
       "close_threads_after": 34,
       "auto_moderate_threads": false,
       "moderate_threads_after": 67,
       "subgroupcategoryid": 65,
       "subs_count": 25,
       "pending_subs_count": 6,
       "pending_msgs_count": 66,
       "open_chats_count": 16,
       "threads_count": 27,
       "messages_count": 42,
       "org_domain": "",
       "most_recent_message": "2009-11-10T15:00:00-08:00",
       "cover_photo_url": "",
       "icon_url": "",
       "group_url": "",
       "allow_parent_subs_to_post": false,
       "send_event_summaries": false,
       "event_summary_schedule": "event_summary_monthly",
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      },
    "topics": [
      {
       "topic": 
         {
          "id": 71,
          "object": "topic",
          "created": "2009-11-10T15:00:00-08:00",
          "updated": "2009-11-10T15:00:00-08:00",
          "group_id": 7,
          "group_subject_tag": "",
          "subject": "",
          "summary": "",
          "name": "",
          "profile_photo_url": "",
          "num_messages": 86,
          "is_sticky": false,
          "is_moderated": false,
          "is_closed": false,
          "has_attachments": false,
          "reply_to": "thread_reply_group_default",
          "most_recent_message": "2009-11-10T15:00:00-08:00",
          "hashtags": [
            {
             "id": 55,
             "object": "hashtag",
             "created": "2009-11-10T15:00:00-08:00",
             "group_id": 5,
             "name": "",
             "alias": 
               {
               },
             "mods_only_post": false,
             "mods_only_replies": false,
             "no_email": false,
             "moderated": false,
             "special": false,
             "replies_unmoderated": false,
             "locked": false,
             "until": "hash_tag_delete_day",
             "close_instead_of_delete": false,
             "description": "",
             "color_name": "tag_antique_pink",
             "color_hex": "",
             "reply_to": "thread_reply_group_default",
             "topic_count": 55,
             "last_message_date": "2009-11-10T15:00:00-08:00",
            }
          ],
         },
       "images": [
         {
          "id": "",
          "object": "attachment",
          "created": "2009-11-10T15:00:00-08:00",
          "group_id": 30,
          "user_id": 13,
          "thread_id": 12,
          "message_num": 60,
          "attach_num": 75,
          "type": "",
          "sub_type": "",
          "name": "",
          "content": "",
          "image_width": 83,
          "image_height": 16,
          "thumbnail_url": "",
         }
       ],
      }
    ],
    "events": [
      {
       "id": 12,
       "object": "event",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "creator_name": "@JohnSmith",
       "group_id": 18,
       "group_name": "",
       "nice_group_name": "",
       "start_time": "2009-11-10T15:00:00-08:00",
       "end_time": "2009-11-10T15:00:00-08:00",
       "timezone": "",
       "all_day": false,
       "name": "",
       "location": "",
       "description": "",
       "organizer_name": "",
       "organizer_email": "",
       "organizer_phone": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "rsvp": false,
       "max_attendees": 29,
       "additional_guests": false,
       "comment_label": "",
       "yes_message": "",
       "has_rsvp": false,
       "rsvp_type": "",
       "rsvp_comment": "",
       "rsvp_additional_guests": 88,
      }
    ],
    "files": [
      {
       "id": 97,
       "object": "file",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 82,
       "group_id": 83,
       "name": "",
       "desc": "",
       "size": 90,
       "path": "",
       "parent_folder_id": 97,
       "is_folder": false,
       "count": 69,
       "media_type": "",
       "download_url": "",
       "display_name": "",
       "user_name": "",
       "profile_photo_url": "",
       "profile_privacy": "",
       "email": "",
      }
    ],
    "photos": [
      {
       "id": 84,
       "object": "photo",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 71,
       "group_id": 59,
       "name": "",
       "desc": "",
       "media_type": "image/jpeg",
       "size": 21,
       "attachment_num": 94,
       "width": 55,
       "height": 91,
       "album_id": 13,
       "display_name": "",
       "user_name": "",
       "profile_photo_url": "",
       "profile_privacy": "",
       "email": "",
       "format": "gif",
       "focal_length": 3.2,
       "iso": 74,
       "aperture": 3.2,
       "shutter_speed": 83,
       "taken": 97,
       "make": "",
       "model": "",
       "thumbnail_url": "",
       "download_url": "",
      }
    ],
    "chats": [
      {
       "id": 9,
       "object": "chat",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 81,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 5,
       "subject": "The chat subject",
       "desc": "This is the description of the chat",
       "is_closed": false,
       "num_messages": 25,
       "chat_sub": 
         {
          "id": 2,
          "object": "chat_sub",
          "created": "2009-11-10T15:00:00-08:00",
          "updated": "2009-11-10T15:00:00-08:00",
          "user_id": 81,
          "group_id": 92,
          "chat_id": 74,
          "last_msg_seen": 60,
         },
      }
    ],
    "wikis": [
      {
       "id": 7,
       "object": "wiki_page",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 87,
       "group_id": 71,
       "title": "",
       "path": "",
       "locked": false,
       "rev_count": 80,
      }
    ],
    "subgroups": [
      {
       "id": 41,
       "object": "group",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "title": "The Example Group",
       "name": "example",
       "nice_group_name": "",
       "alias": "",
       "desc": "This is the description for the example group.",
       "plain_desc": "This is the description for the example group.",
       "subject_tag": "[example]",
       "footer": "",
       "website": "",
       "announce": false,
       "moderated": false,
       "new_users_moderated": false,
       "unmoderate_users_after": 65,
       "restricted": false,
       "allow_non_subs_to_post": false,
       "force_html_emails": false,
       "normalize_html_emails": false,
       "reply_to": "group_reply_only_to_sender",
       "remove_other_reply_options": false,
       "privacy": "group_privacy_archives",
       "seperate_footers": false,
       "allow_downloads": "allow_downloads_by_members",
       "members_visible": "group_view_members_moderators",
       "subgroup_access": "sub_group_moderators",
       "calendar_access": "group_access_limited",
       "files_access": "group_access_limited",
       "database_access": "group_access_limited",
       "wiki_access": "group_access_limited",
       "photos_access": "group_access_limited",
       "member_directory_access": "group_access_limited",
       "polls_access": "polls_access_limited",
       "chat_access": "group_access_limited",
       "handle_attachments": "group_attachments_bounced",
       "plain_text_only": false,
       "handle_virus": "handle_virus_block",
       "locked": false,
       "has_cover_photo": false,
       "has_icon": false,
       "parent_group_id": 75,
       "org_id": 24,
       "max_photo_size_email": "max_photo_size_ex_small",
       "max_photo_size_photos": "max_photo_size_ex_small",
       "max_photo_size_databases": "max_photo_size_ex_small",
       "max_photo_size_wiki_images": "max_photo_size_ex_small",
       "hash_tags_required": false,
       "hash_tag_permissions": "hash_tag_create_mods_bounce",
       "bounce_attachments": false,
       "allow_photos_in_files": false,
       "allow_reposts": false,
       "min_days_between_reposts": 33,
       "max_number_of_reposts": 30,
       "email_delivery_default": "email_delivery_digest",
       "message_selection_default": "message_selection_all",
       "auto_follow_replies_default": false,
       "max_attachment_size_default": "max_attachment_size_large",
       "default_timezone": "",
       "default_time_pref": "military_time",
       "default_date_pref": "international_date",
       "default_monday_start": false,
       "disable_edits": false,
       "disable_no_email": false,
       "auto_close_threads": false,
       "close_threads_after": 42,
       "auto_moderate_threads": false,
       "moderate_threads_after": 52,
       "subgroupcategoryid": 56,
       "subs_count": 22,
       "pending_subs_count": 39,
       "pending_msgs_count": 99,
       "open_chats_count": 92,
       "threads_count": 87,
       "messages_count": 43,
       "org_domain": "",
       "most_recent_message": "2009-11-10T15:00:00-08:00",
       "cover_photo_url": "",
       "icon_url": "",
       "group_url": "",
       "allow_parent_subs_to_post": false,
       "send_event_summaries": false,
       "event_summary_schedule": "event_summary_monthly",
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      }
    ],
    "tables": [
      {
       "id": 62,
       "object": "databasetable",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "group_id": 32,
       "user_id": 35,
       "name": "",
       "short_desc": "",
       "desc": "",
       "desc_type": "",
       "edit_table": "",
       "edit_rows": "",
       "add_rows": "",
       "view_table": "",
       "num_rows": 54,
       "max_row_id": 71,
       "num_columns": 34,
       "max_col_id": 62,
       "display_template": "",
       "columns": [
         {
          "id": 66,
          "name": "",
          "type": "",
          "required": false,
          "color": "",
          "choices": [""],
          "width": 1,
         }
       ],
      }
    ],
    "hashtags": [
      {
       "id": 73,
       "object": "hashtag",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 78,
       "name": "",
       "alias": 
         {
         },
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": false,
       "replies_unmoderated": false,
       "locked": false,
       "until": "hash_tag_delete_day",
       "close_instead_of_delete": false,
       "description": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "reply_to": "thread_reply_group_default",
       "topic_count": 15,
       "last_message_date": "2009-11-10T15:00:00-08:00",
      }
    ],
   }
 ],
}

The Feed Topic Object#

The Feed Topic object combines a Topic object and an array of Images that go with the most recent message in that topic.

Response Attributes

topic Topic object
images optional array of Attachment objects

Example Response

{
 "topic": 
   {
    "id": 80,
    "object": "topic",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 48,
    "group_subject_tag": "",
    "subject": "",
    "summary": "",
    "name": "",
    "profile_photo_url": "",
    "num_messages": 22,
    "is_sticky": false,
    "is_moderated": false,
    "is_closed": false,
    "has_attachments": false,
    "reply_to": "thread_reply_group_default",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "hashtags": [
      {
       "id": 20,
       "object": "hashtag",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 91,
       "name": "",
       "alias": 
         {
         },
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": false,
       "replies_unmoderated": false,
       "locked": false,
       "until": "hash_tag_delete_day",
       "close_instead_of_delete": false,
       "description": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "reply_to": "thread_reply_group_default",
       "topic_count": 56,
       "last_message_date": "2009-11-10T15:00:00-08:00",
      }
    ],
   },
 "images": [
   {
    "id": "",
    "object": "attachment",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 59,
    "user_id": 99,
    "thread_id": 2,
    "message_num": 44,
    "attach_num": 61,
    "type": "",
    "sub_type": "",
    "name": "",
    "content": "",
    "image_width": 12,
    "image_height": 16,
    "thumbnail_url": "",
   }
 ],
}

The File Object#

The file object.

Response Attributes

id integer
object string	file.
created string date-time
updated string date-time
user_id integer
group_id integer
name string
desc string
size number
path string	The path to get to this file or folder.
parent_folder_id integer	If this is a sub folder, this is the ID of the parent folder.
is_folder boolean	If this is a directory.
count number	If this is a directory, how many items are within it.
media_type string	If this is a file, the media type.
download_url string
display_name string
user_name string
profile_photo_url string
profile_privacy string	Privacy setting of the sender of the message.
email string	Possibly obscured, depending on group settings.

Methods That Use This Object

Get File	View Method

Example Response

{
 "id": 16,
 "object": "file",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 14,
 "group_id": 32,
 "name": "",
 "desc": "",
 "size": 56,
 "path": "",
 "parent_folder_id": 1,
 "is_folder": false,
 "count": 64,
 "media_type": "",
 "download_url": "",
 "display_name": "",
 "user_name": "",
 "profile_photo_url": "",
 "profile_privacy": "",
 "email": "",
}

The File List Object#

File List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
path string	Path to this directory level.
files_percentage number	Percentage of total storage used by the Files section.
files_gigs string	Number of GB used by the Files section.
data array of File objects

Methods That Use This Object

Get File Directory	View Method
Search Files	View Method
Add Files	View Method

Example Response

{
 "object": "list",
 "total_count": 84,
 "start_item": 40,
 "end_item": 31,
 "has_more": false,
 "next_page_token": 21,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "path": "",
 "files_percentage": 55,
 "files_gigs": "",
 "data": [
   {
    "id": 26,
    "object": "file",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 49,
    "group_id": 6,
    "name": "",
    "desc": "",
    "size": 66,
    "path": "",
    "parent_folder_id": 30,
    "is_folder": false,
    "count": 66,
    "media_type": "",
    "download_url": "",
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
   }
 ],
}

The Group Object#

The group object.

Response Attributes

id integer	Unique ID of the group object.
object string	group.
created string date-time
updated string date-time
title string	Group title.
name string	Group name.
nice_group_name string	Nice version of the group name.
alias string	Alias.
desc string	Group description, in HTML.
plain_desc string	Plain text version of the description.
subject_tag string	Prepended to subject lines.
footer string	Appended to group messages.
website string	URL of associated website.
announce boolean
moderated boolean
new_users_moderated boolean
unmoderate_users_after number	Unmoderate users after N consecutive approved posts.
restricted boolean
allow_non_subs_to_post boolean
force_html_emails boolean
normalize_html_emails boolean	strip all font/colors/bg stuff from messages.
reply_to string	Can be one of: `group_reply_only_to_sender`, `group_reply_to_group`, `group_reply_to_group_and_sender`, `group_reply_to_moderators`, `group_reply_to_sender`.
remove_other_reply_options boolean
privacy string	Can be one of: `group_privacy_archives`, `group_privacy_none`, `group_privacy_unlisted`, `group_privacy_unlisted_public`, `sub_group_privacy_unlisted_public_archives`.
seperate_footers boolean	Place message footers in separate mime part.
allow_downloads string	If we let members download archives. Can be one of: `allow_downloads_by_members`, `allow_downloads_no`.
members_visible string	Can be one of: `group_view_members_moderators`, `group_view_members_owners`, `group_view_members_subs`.
subgroup_access string	Who can create subgroups. Can be one of: `sub_group_moderators`, `sub_group_owners`, `sub_group_subs`.
calendar_access string	Access control for the calendar. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
files_access string	Access control for the files section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
database_access string	Access control for the database section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
wiki_access string	Access control for the wiki section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
photos_access string	Access control for the photo section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
member_directory_access string	Access control for the member directory section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
polls_access string	Access control for the polls section. Can be one of: `polls_access_limited`, `polls_access_none`, `polls_access_subscribers`.
chat_access string	Access control for the chat section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
handle_attachments string	Can be one of: `group_attachments_bounced`, `group_attachments_moderated`, `group_attachments_normal`, `group_attachments_stripped`.
plain_text_only boolean
handle_virus string	How we handle messages that may have viruses. Can be one of: `handle_virus_block`, `handle_virus_moderate`.
locked boolean	If the group is locked.
has_cover_photo boolean
has_icon boolean
parent_group_id integer
org_id integer
max_photo_size_email string	If we resize photos in emails. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
max_photo_size_photos string	If we resize photos uploaded to the photos section. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
max_photo_size_databases string	If we resize photos uploaded to database tables. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
max_photo_size_wiki_images string	If we resize photos uploaded to the wiki. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
hash_tags_required boolean	whether messages must be tagged or not.
hash_tag_permissions string	Can be one of: `hash_tag_create_mods_bounce`, `hash_tag_create_mods_remove`, `hash_tag_create_subs`.
bounce_attachments boolean	If out of space, bounce messages with attachments instead of deleting old attachments.
allow_photos_in_files boolean	Whether to allow photos in the Files section.
allow_reposts boolean	If true, members can repost messages. Only used with premium and enterprise groups.
min_days_between_reposts number	The minimum number of days between reposts.
max_number_of_reposts number	The maximum number of times a member can repost their message.
email_delivery_default string	Default options for new subscriptions. Can be one of: `email_delivery_digest`, `email_delivery_html_digest`, `email_delivery_none`, `email_delivery_single`, `email_delivery_special`, `email_delivery_summary`.
message_selection_default string	Can be one of: `message_selection_all`, `message_selection_follow_and_first_message`, `message_selection_follow_only`.
auto_follow_replies_default boolean
max_attachment_size_default string	Can be one of: `max_attachment_size_large`, `max_attachment_size_medium`, `max_attachment_size_none`, `max_attachment_size_small`, `max_attachment_size_unlimited`.
default_timezone string
default_time_pref string	Can be one of: `military_time`, `standard_time`.
default_date_pref string	Can be one of: `international_date`, `iso_date`, `us_date`.
default_monday_start boolean
disable_edits boolean	Disable ability for members to edit messages.
disable_no_email boolean	Disable ability for members to be set to No Email.
auto_close_threads boolean	Automatically lock threads after a set number of days.
close_threads_after number	unit is days.
auto_moderate_threads boolean	Automatically moderate threads after a set number of days.
moderate_threads_after number	unit is days.
subgroupcategoryid number	ID of the subgroupcategory object this group belongs to, if any.
subs_count number	Number of subscribers of the group, both normal and pending.
pending_subs_count number	Number of pending subscribers, for restricted groups.
pending_msgs_count number	Number of pending messages requiring approval.
open_chats_count number	Number of open chats.
threads_count number	Number of message threads in the archives.
messages_count number	Number of messages in the archives.
org_domain string
most_recent_message string date-time
cover_photo_url string
icon_url string
group_url string
allow_parent_subs_to_post boolean	If this is a subgroup, we can allow parent subscribers to post messages to it.
send_event_summaries boolean	Send calendar event summary emails.
event_summary_schedule string	Can be one of: `event_summary_monthly`, `event_summary_weekly_friday`.
perms optional Perms object	If you are subscribed to the group, these are the permissions you have.

Methods That Use This Object

Create Group	View Method
Create Sub Group	View Method
Get Group Settings	View Method
Update Group	View Method

Example Response

{
 "id": 87,
 "object": "group",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "title": "The Example Group",
 "name": "example",
 "nice_group_name": "",
 "alias": "",
 "desc": "This is the description for the example group.",
 "plain_desc": "This is the description for the example group.",
 "subject_tag": "[example]",
 "footer": "",
 "website": "",
 "announce": false,
 "moderated": false,
 "new_users_moderated": false,
 "unmoderate_users_after": 79,
 "restricted": false,
 "allow_non_subs_to_post": false,
 "force_html_emails": false,
 "normalize_html_emails": false,
 "reply_to": "group_reply_only_to_sender",
 "remove_other_reply_options": false,
 "privacy": "group_privacy_archives",
 "seperate_footers": false,
 "allow_downloads": "allow_downloads_by_members",
 "members_visible": "group_view_members_moderators",
 "subgroup_access": "sub_group_moderators",
 "calendar_access": "group_access_limited",
 "files_access": "group_access_limited",
 "database_access": "group_access_limited",
 "wiki_access": "group_access_limited",
 "photos_access": "group_access_limited",
 "member_directory_access": "group_access_limited",
 "polls_access": "polls_access_limited",
 "chat_access": "group_access_limited",
 "handle_attachments": "group_attachments_bounced",
 "plain_text_only": false,
 "handle_virus": "handle_virus_block",
 "locked": false,
 "has_cover_photo": false,
 "has_icon": false,
 "parent_group_id": 57,
 "org_id": 21,
 "max_photo_size_email": "max_photo_size_ex_small",
 "max_photo_size_photos": "max_photo_size_ex_small",
 "max_photo_size_databases": "max_photo_size_ex_small",
 "max_photo_size_wiki_images": "max_photo_size_ex_small",
 "hash_tags_required": false,
 "hash_tag_permissions": "hash_tag_create_mods_bounce",
 "bounce_attachments": false,
 "allow_photos_in_files": false,
 "allow_reposts": false,
 "min_days_between_reposts": 1,
 "max_number_of_reposts": 14,
 "email_delivery_default": "email_delivery_digest",
 "message_selection_default": "message_selection_all",
 "auto_follow_replies_default": false,
 "max_attachment_size_default": "max_attachment_size_large",
 "default_timezone": "",
 "default_time_pref": "military_time",
 "default_date_pref": "international_date",
 "default_monday_start": false,
 "disable_edits": false,
 "disable_no_email": false,
 "auto_close_threads": false,
 "close_threads_after": 9,
 "auto_moderate_threads": false,
 "moderate_threads_after": 10,
 "subgroupcategoryid": 85,
 "subs_count": 88,
 "pending_subs_count": 47,
 "pending_msgs_count": 58,
 "open_chats_count": 19,
 "threads_count": 12,
 "messages_count": 12,
 "org_domain": "",
 "most_recent_message": "2009-11-10T15:00:00-08:00",
 "cover_photo_url": "",
 "icon_url": "",
 "group_url": "",
 "allow_parent_subs_to_post": false,
 "send_event_summaries": false,
 "event_summary_schedule": "event_summary_monthly",
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

The Group Alias Object#

The group alias object.

Response Attributes

id integer
object string	groupalias.
created string date-time
updated string date-time
name string	Name.
alias_group_id integer	If not 0, this is not a real group, but an alias to another group.

Example Response

{
 "id": 5,
 "object": "groupalias",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "name": "example",
 "alias_group_id": 92,
}

The Group Alias List Object#

/getgroupaliases return object.

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Group Alias objects

Methods That Use This Object

Get Group Aliases	View Method

Example Response

{
 "object": "list",
 "total_count": 19,
 "start_item": 41,
 "end_item": 55,
 "has_more": false,
 "next_page_token": 30,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 53,
    "object": "groupalias",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "name": "example",
    "alias_group_id": 66,
   }
 ],
}

The Group List Object#

/getsubgroups return object.

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Group objects

Methods That Use This Object

Get Sub Groups	View Method

Example Response

{
 "object": "list",
 "total_count": 37,
 "start_item": 24,
 "end_item": 87,
 "has_more": false,
 "next_page_token": 48,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 61,
    "object": "group",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "title": "The Example Group",
    "name": "example",
    "nice_group_name": "",
    "alias": "",
    "desc": "This is the description for the example group.",
    "plain_desc": "This is the description for the example group.",
    "subject_tag": "[example]",
    "footer": "",
    "website": "",
    "announce": false,
    "moderated": false,
    "new_users_moderated": false,
    "unmoderate_users_after": 86,
    "restricted": false,
    "allow_non_subs_to_post": false,
    "force_html_emails": false,
    "normalize_html_emails": false,
    "reply_to": "group_reply_only_to_sender",
    "remove_other_reply_options": false,
    "privacy": "group_privacy_archives",
    "seperate_footers": false,
    "allow_downloads": "allow_downloads_by_members",
    "members_visible": "group_view_members_moderators",
    "subgroup_access": "sub_group_moderators",
    "calendar_access": "group_access_limited",
    "files_access": "group_access_limited",
    "database_access": "group_access_limited",
    "wiki_access": "group_access_limited",
    "photos_access": "group_access_limited",
    "member_directory_access": "group_access_limited",
    "polls_access": "polls_access_limited",
    "chat_access": "group_access_limited",
    "handle_attachments": "group_attachments_bounced",
    "plain_text_only": false,
    "handle_virus": "handle_virus_block",
    "locked": false,
    "has_cover_photo": false,
    "has_icon": false,
    "parent_group_id": 87,
    "org_id": 58,
    "max_photo_size_email": "max_photo_size_ex_small",
    "max_photo_size_photos": "max_photo_size_ex_small",
    "max_photo_size_databases": "max_photo_size_ex_small",
    "max_photo_size_wiki_images": "max_photo_size_ex_small",
    "hash_tags_required": false,
    "hash_tag_permissions": "hash_tag_create_mods_bounce",
    "bounce_attachments": false,
    "allow_photos_in_files": false,
    "allow_reposts": false,
    "min_days_between_reposts": 84,
    "max_number_of_reposts": 15,
    "email_delivery_default": "email_delivery_digest",
    "message_selection_default": "message_selection_all",
    "auto_follow_replies_default": false,
    "max_attachment_size_default": "max_attachment_size_large",
    "default_timezone": "",
    "default_time_pref": "military_time",
    "default_date_pref": "international_date",
    "default_monday_start": false,
    "disable_edits": false,
    "disable_no_email": false,
    "auto_close_threads": false,
    "close_threads_after": 96,
    "auto_moderate_threads": false,
    "moderate_threads_after": 86,
    "subgroupcategoryid": 33,
    "subs_count": 46,
    "pending_subs_count": 97,
    "pending_msgs_count": 14,
    "open_chats_count": 97,
    "threads_count": 44,
    "messages_count": 18,
    "org_domain": "",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "cover_photo_url": "",
    "icon_url": "",
    "group_url": "",
    "allow_parent_subs_to_post": false,
    "send_event_summaries": false,
    "event_summary_schedule": "event_summary_monthly",
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

The Hashtag Object#

The hashtag object.

Response Attributes

id integer	Unique ID of the hashtag object.
object string	hashtag.
created string date-time
group_id integer
name string
alias optional Hashtag object
mods_only_post boolean
mods_only_replies boolean
no_email boolean
moderated boolean
special boolean
replies_unmoderated boolean
locked boolean
until string	Can be one of: `hash_tag_delete_day`, `hash_tag_delete_forever`, `hash_tag_delete_hour`, `hash_tag_delete_month`, `hash_tag_delete_week`, `hash_tag_delete_year`.
close_instead_of_delete boolean
description string
color_name string	Can be one of: `tag_antique_pink`, `tag_apricot`, `tag_aquamute`, `tag_beige`, `tag_bluejean`, `tag_blush`, `tag_burnt_yellow`, `tag_capri_blue`, `tag_cerulean_blue`, `tag_cherry_blossom`, `tag_cloudy_blue`, `tag_cucumber`, `tag_dark_grey`, `tag_dark_orange`, `tag_dusty_mauve`, `tag_emerald_green`, `tag_grape`, `tag_green_lantern`, `tag_green_sage`, `tag_grey_blue`, `tag_light_brown`, `tag_light_grey`, `tag_light_lilac`, `tag_lilac`, `tag_lips`, `tag_melon`, `tag_military`, `tag_moss_green`, `tag_mulbery`, `tag_mustard`, `tag_orange`, `tag_orchid`, `tag_peony`, `tag_pink`, `tag_purple`, `tag_purple_blue`, `tag_purple_grey`, `tag_sage`, `tag_sky`, `tag_terracotta`, `tag_tomato`, `tag_yellow`.
color_hex string
reply_to string	Can be one of: `thread_reply_group_default`, `thread_reply_only_to_sender`, `thread_reply_to_group`, `thread_reply_to_group_and_sender`, `thread_reply_to_moderators`, `thread_reply_to_sender`.
topic_count number
last_message_date string date-time

Example Response

{
 "id": 3,
 "object": "hashtag",
 "created": "2009-11-10T15:00:00-08:00",
 "group_id": 89,
 "name": "",
 "alias": 
   {
   },
 "mods_only_post": false,
 "mods_only_replies": false,
 "no_email": false,
 "moderated": false,
 "special": false,
 "replies_unmoderated": false,
 "locked": false,
 "until": "hash_tag_delete_day",
 "close_instead_of_delete": false,
 "description": "",
 "color_name": "tag_antique_pink",
 "color_hex": "",
 "reply_to": "thread_reply_group_default",
 "topic_count": 34,
 "last_message_date": "2009-11-10T15:00:00-08:00",
}

The Hashtag List Object#

Hashtag List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Hashtag objects

Methods That Use This Object

Get Hashtags	View Method

Example Response

{
 "object": "list",
 "total_count": 35,
 "start_item": 81,
 "end_item": 74,
 "has_more": false,
 "next_page_token": 91,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 96,
    "object": "hashtag",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 4,
    "name": "",
    "alias": 
      {
      },
    "mods_only_post": false,
    "mods_only_replies": false,
    "no_email": false,
    "moderated": false,
    "special": false,
    "replies_unmoderated": false,
    "locked": false,
    "until": "hash_tag_delete_day",
    "close_instead_of_delete": false,
    "description": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "reply_to": "thread_reply_group_default",
    "topic_count": 56,
    "last_message_date": "2009-11-10T15:00:00-08:00",
   }
 ],
}

The Login Object#

The login object.

Response Attributes

token string
user User object

Methods That Use This Object

Login	View Method
Facebook Login Final	View Method
Google Login Final	View Method
Register User	View Method

Example Response

{
 "token": "aabbffed2213234",
 "user": 
   {
    "id": 42,
    "object": "user",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "email": "user@example.com",
    "full_name": "",
    "user_name": "",
    "timezone": "",
    "status": "user_status_bounced",
    "profile_photo_url": "",
    "post_pref": "",
    "per_page_pref": "",
    "allow_facebook_login": false,
    "allow_google_login": false,
    "allow_sso_login": false,
    "csrf_token": "",
    "two_factor_enabled": false,
    "recovery_codes": "",
    "dont_munge_message_id": false,
    "about_me": "",
    "about_format": "",
    "location": "",
    "website": "",
    "time_pref": "",
    "date_pref": "",
    "monday_start": false,
    "profile_privacy": "",
    "default_message_view": "expanded_message_view",
    "topics_sort_dir": "",
    "topic_sort_dir": "",
    "messages_sort_dir": "",
    "expanded_messages_sort_dir": "",
    "search_sort": "",
    "search_sort_dir": "",
    "photos_order_by": "",
    "photos_sort_dir": "",
    "album_order_by": "",
    "album_sort_dir": "",
    "home_page": "",
    "subscriptions": [
      {
       "id": 6,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 84,
       "group_id": 92,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 17,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 53,
       "pending_subs": 49,
       "pending_msgs": 75,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      }
    ],
   },
}

The Member Info Object#

The member info object. This represents a subscription to a group. Fields marked as optional may not always be returned, depending on the call returning this object.

Response Attributes

id integer	Unique ID of the member_info object.
object string	member_info.
created string date-time	The time that this object was created.
updated string date-time	The time that this object was last updated.
user_id integer
group_id integer
group_name string
status optional string	Can be one of: `sub_status_banned`, `sub_status_normal`, `sub_status_pending`.
post_status optional string	Can be one of: `sub_poststatus_allowed`, `sub_poststatus_moderated`, `sub_poststatus_modfirstmessage`, `sub_poststatus_modstartedtopics`, `sub_poststatus_newusermoderated`, `sub_poststatus_normal`, `sub_poststatus_notallowed`.
email_delivery optional string	Can be one of: `email_delivery_digest`, `email_delivery_html_digest`, `email_delivery_none`, `email_delivery_single`, `email_delivery_special`, `email_delivery_summary`.
message_selection optional string	Can be one of: `message_selection_all`, `message_selection_follow_and_first_message`, `message_selection_follow_only`.
auto_follow_replies optional boolean
max_attachment_size optional string	Can be one of: `max_attachment_size_large`, `max_attachment_size_medium`, `max_attachment_size_none`, `max_attachment_size_small`, `max_attachment_size_unlimited`.
approved_posts optional number	The count of consecutive approved posts. Only applicable when post_status is `sub_poststatus_newusermoderated`.
mod_status optional string	Moderator data. Can be one of: `sub_modstatus_moderator`, `sub_modstatus_none`, `sub_modstatus_owner`.
pending_msg_notify optional string	Can be one of: `sub_notify_email`, `sub_notify_none`.
pending_sub_notify optional string	Can be one of: `sub_notify_email`, `sub_notify_none`.
sub_notify optional string	Can be one of: `sub_notify_email`, `sub_notify_none`.
storage_notify optional string	Can be one of: `sub_notify_email`, `sub_notify_none`.
sub_group_notify optional string	Can be one of: `sub_notify_email`, `sub_notify_none`.
message_report_notify optional string	Can be one of: `sub_notify_email`, `sub_notify_none`.
mod_permissions optional string	Can be more than one of: `sub_perm_banmembers`, `sub_perm_billing`, `sub_perm_createhashtags`, `sub_perm_editarchives`, `sub_perm_groupsettings`, `sub_perm_integrations`, `sub_perm_invitemembers`, `sub_perm_makemoderator`, `sub_perm_managepaidsubscriptions`, `sub_perm_managesubgroups`, `sub_perm_modsub`, `sub_perm_none`, `sub_perm_pendingmembers`, `sub_perm_pendingmsgs`, `sub_perm_removemembers`, `sub_perm_viewmembers`.
owner_msg_notify optional string	Can be one of: `sub_ownermsg_notify_all`, `sub_ownermsg_notify_none`, `sub_ownermsg_notify_subs`.
email optional string
user_status optional string	Can be one of: `user_status_bounced`, `user_status_bouncing`, `user_status_confirmed`, `user_status_inactive`, `user_status_not_confirmed`.
user_name string
timezone optional string
full_name string
about_me optional string	About me, in HTML format.
location optional string
website optional string
profile_photo_url optional string	Empty if no profile photo.
profile_privacy optional string	Can be one of: `profile_members`, `profile_private`, `profile_public`.
dont_munge_message_id optional boolean
use_signature optional boolean
use_signature_email optional boolean
signature optional string
moderator_notes optional string	Any moderator notes. The moderator_notes field is only set when an account with the appropriate permissions requests this.
moderator_notes_updated optional string date-time	The last time the moderator_notes field was updated. The moderator_notes_updated field is only set when an account with the appropriate permissions requests this.
num_drafts optional number	The number of drafts this person has open in this group. This field is only set by the `getsubscriptions` endpoint.
pending_subs optional number	The number of pending subscribers this group has.
pending_msgs optional number	The number of pending messages this group has.
perms optional Perms object	If you are subscribed to the group, these are the permissions you have.

Methods That Use This Object

Approve Pending Member	View Method
Ban Member	View Method
Bulk Remove Members	View Method
Get Member	View Method
Remove Member	View Method
Send A Bounce Probe	View Method
Send A Confirmation Email	View Method
Update Member	View Method
Get Subscription	View Method
Update Subscription	View Method

Example Response

{
 "id": 81,
 "object": "member_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 73,
 "group_id": 41,
 "group_name": "mygroup",
 "status": "sub_status_banned",
 "post_status": "sub_poststatus_allowed",
 "email_delivery": "email_delivery_digest",
 "message_selection": "message_selection_all",
 "auto_follow_replies": false,
 "max_attachment_size": "max_attachment_size_large",
 "approved_posts": 50,
 "mod_status": "sub_modstatus_moderator",
 "pending_msg_notify": "sub_notify_email",
 "pending_sub_notify": "sub_notify_email",
 "sub_notify": "sub_notify_email",
 "storage_notify": "sub_notify_email",
 "sub_group_notify": "sub_notify_email",
 "message_report_notify": "sub_notify_email",
 "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
 "owner_msg_notify": "sub_ownermsg_notify_all",
 "email": "joe@example.com",
 "user_status": "user_status_bounced",
 "user_name": "joe",
 "timezone": "America/Los_Angeles",
 "full_name": "Joe Smith",
 "about_me": "",
 "location": "",
 "website": "https://example.com",
 "profile_photo_url": "",
 "profile_privacy": "profile_members",
 "dont_munge_message_id": false,
 "use_signature": false,
 "use_signature_email": false,
 "signature": "",
 "moderator_notes": "",
 "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
 "num_drafts": 65,
 "pending_subs": 21,
 "pending_msgs": 14,
 "perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
}

The Member Info List Object#

The Member Info List object contains a list of Member Info objects.

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Member Info objects

Methods That Use This Object

Chat Members	View Method
Get Members	View Method
Search Members	View Method
Get Subscriptions	View Method

Example Response

{
 "object": "list",
 "total_count": 34,
 "start_item": 76,
 "end_item": 42,
 "has_more": false,
 "next_page_token": 88,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 52,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 60,
    "group_id": 31,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 60,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 17,
    "pending_subs": 2,
    "pending_msgs": 71,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

The Member Notice Object#

The member notice object.

Response Attributes

id integer	Unique ID of the member_notice object.
object string	member_notice.
created string date-time
updated string date-time
group_id integer
type string	Type of member notice. Can be one of: `member_notice_banned`, `member_notice_direct_add`, `member_notice_guidelines`, `member_notice_invite`, `member_notice_joining`, `member_notice_leaving`, `member_notice_locked_group`, `member_notice_monthly_reminder`, `member_notice_pending`, `member_notice_post_to_sub`, `member_notice_rejected_message`, `member_notice_rejected_sub`, `member_notice_removed_sub`.
name string	Name of this member notice.
subject string	Subject used when sending emails.
message string	The message, in HTML format.
is_default boolean	Use this message for email commands.
send_monthly boolean	For Guidelines, send monthly to the group members.
send_monthly_special boolean	For Guidelines, send monthly to members on special only.
send_on_join boolean	For Guidelines, send to new members at same time as welcome message.
private boolean	For Guidelines, if the guidelines are public or for members only.
guidelines_monthly_subject string	For Guidelines, the subject to use when sending the monthly email.

Methods That Use This Object

New Member Notice	View Method
Update Member Notice	View Method

Example Response

{
 "id": 34,
 "object": "member_notice",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 6,
 "type": "member_notice_banned",
 "name": "",
 "subject": "",
 "message": "",
 "is_default": false,
 "send_monthly": false,
 "send_monthly_special": false,
 "send_on_join": false,
 "private": false,
 "guidelines_monthly_subject": "",
}

The Member Notice List Object#

Member Notice List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Member Notice objects

Methods That Use This Object

Get Member Notices	View Method

Example Response

{
 "object": "list",
 "total_count": 9,
 "start_item": 82,
 "end_item": 17,
 "has_more": false,
 "next_page_token": 52,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 39,
    "object": "member_notice",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 60,
    "type": "member_notice_banned",
    "name": "",
    "subject": "",
    "message": "",
    "is_default": false,
    "send_monthly": false,
    "send_monthly_special": false,
    "send_on_join": false,
    "private": false,
    "guidelines_monthly_subject": "",
   }
 ],
}

The Message Object#

The message object.

Response Attributes

id integer
object string	message.
created string date-time
updated string date-time
user_id integer
group_id integer
topic_id integer
body string	body of the message to display, minus any quoted section at the end.
quoted string	any quoted section at the end of the message.
remainder string	for HTML messages, there may be a remainder part with just closing html tags.
snippet string	Snippet, used for collapsed messages display.
subject string	Subject of the message.
name string
profile_photo_url string	If not empty, use this URL to fetch the profile photo associated with the author of this message.
is_plain_text boolean
msg_num number
has_liked boolean	If we've liked this message.
num_likes number	Number of likes, not including our own.
is_closed boolean	If the thread this message is a part of is closed.
is_moderated boolean	If the thread this message is a part of is moderated.
reply_to string	ReplyTo for this message (normally Group.ReplyTo unless modified by a tag). Can be one of: `group_reply_only_to_sender`, `group_reply_to_group`, `group_reply_to_group_and_sender`, `group_reply_to_moderators`, `group_reply_to_sender`.
can_repost boolean	if we can repost this message.
hashtags array of Hashtag objects
poll_id integer	If this is a Poll, this is the ID of the Poll object.

Example Response

{
 "id": 84,
 "object": "message",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 76,
 "group_id": 14,
 "topic_id": 41,
 "body": "",
 "quoted": "",
 "remainder": "",
 "snippet": "",
 "subject": "",
 "name": "",
 "profile_photo_url": "",
 "is_plain_text": false,
 "msg_num": 0,
 "has_liked": false,
 "num_likes": 5,
 "is_closed": false,
 "is_moderated": false,
 "reply_to": "group_reply_only_to_sender",
 "can_repost": false,
 "hashtags": [
   {
    "id": 2,
    "object": "hashtag",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 89,
    "name": "",
    "alias": 
      {
      },
    "mods_only_post": false,
    "mods_only_replies": false,
    "no_email": false,
    "moderated": false,
    "special": false,
    "replies_unmoderated": false,
    "locked": false,
    "until": "hash_tag_delete_day",
    "close_instead_of_delete": false,
    "description": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "reply_to": "thread_reply_group_default",
    "topic_count": 47,
    "last_message_date": "2009-11-10T15:00:00-08:00",
   }
 ],
 "poll_id": 73,
}

The Message List Object#

Message List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
group_perms optional Perms object
group optional Group object
cover_photo_url optional string
sub_data optional array of Member Info objects
topic optional Topic object
data array of Message objects

Methods That Use This Object

Get Topic	View Method
Get Messages	View Method

Example Response

{
 "object": "list",
 "total_count": 59,
 "start_item": 32,
 "end_item": 10,
 "has_more": false,
 "next_page_token": 17,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
 "group": 
   {
    "id": 53,
    "object": "group",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "title": "The Example Group",
    "name": "example",
    "nice_group_name": "",
    "alias": "",
    "desc": "This is the description for the example group.",
    "plain_desc": "This is the description for the example group.",
    "subject_tag": "[example]",
    "footer": "",
    "website": "",
    "announce": false,
    "moderated": false,
    "new_users_moderated": false,
    "unmoderate_users_after": 84,
    "restricted": false,
    "allow_non_subs_to_post": false,
    "force_html_emails": false,
    "normalize_html_emails": false,
    "reply_to": "group_reply_only_to_sender",
    "remove_other_reply_options": false,
    "privacy": "group_privacy_archives",
    "seperate_footers": false,
    "allow_downloads": "allow_downloads_by_members",
    "members_visible": "group_view_members_moderators",
    "subgroup_access": "sub_group_moderators",
    "calendar_access": "group_access_limited",
    "files_access": "group_access_limited",
    "database_access": "group_access_limited",
    "wiki_access": "group_access_limited",
    "photos_access": "group_access_limited",
    "member_directory_access": "group_access_limited",
    "polls_access": "polls_access_limited",
    "chat_access": "group_access_limited",
    "handle_attachments": "group_attachments_bounced",
    "plain_text_only": false,
    "handle_virus": "handle_virus_block",
    "locked": false,
    "has_cover_photo": false,
    "has_icon": false,
    "parent_group_id": 78,
    "org_id": 62,
    "max_photo_size_email": "max_photo_size_ex_small",
    "max_photo_size_photos": "max_photo_size_ex_small",
    "max_photo_size_databases": "max_photo_size_ex_small",
    "max_photo_size_wiki_images": "max_photo_size_ex_small",
    "hash_tags_required": false,
    "hash_tag_permissions": "hash_tag_create_mods_bounce",
    "bounce_attachments": false,
    "allow_photos_in_files": false,
    "allow_reposts": false,
    "min_days_between_reposts": 81,
    "max_number_of_reposts": 60,
    "email_delivery_default": "email_delivery_digest",
    "message_selection_default": "message_selection_all",
    "auto_follow_replies_default": false,
    "max_attachment_size_default": "max_attachment_size_large",
    "default_timezone": "",
    "default_time_pref": "military_time",
    "default_date_pref": "international_date",
    "default_monday_start": false,
    "disable_edits": false,
    "disable_no_email": false,
    "auto_close_threads": false,
    "close_threads_after": 99,
    "auto_moderate_threads": false,
    "moderate_threads_after": 56,
    "subgroupcategoryid": 12,
    "subs_count": 70,
    "pending_subs_count": 69,
    "pending_msgs_count": 1,
    "open_chats_count": 19,
    "threads_count": 22,
    "messages_count": 16,
    "org_domain": "",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "cover_photo_url": "",
    "icon_url": "",
    "group_url": "",
    "allow_parent_subs_to_post": false,
    "send_event_summaries": false,
    "event_summary_schedule": "event_summary_monthly",
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
 "cover_photo_url": "",
 "sub_data": [
   {
    "id": 25,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 92,
    "group_id": 47,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 96,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 1,
    "pending_subs": 69,
    "pending_msgs": 49,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
 "topic": 
   {
    "id": 16,
    "object": "topic",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 14,
    "group_subject_tag": "",
    "subject": "",
    "summary": "",
    "name": "",
    "profile_photo_url": "",
    "num_messages": 83,
    "is_sticky": false,
    "is_moderated": false,
    "is_closed": false,
    "has_attachments": false,
    "reply_to": "thread_reply_group_default",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "hashtags": [
      {
       "id": 21,
       "object": "hashtag",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 37,
       "name": "",
       "alias": 
         {
         },
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": false,
       "replies_unmoderated": false,
       "locked": false,
       "until": "hash_tag_delete_day",
       "close_instead_of_delete": false,
       "description": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "reply_to": "thread_reply_group_default",
       "topic_count": 8,
       "last_message_date": "2009-11-10T15:00:00-08:00",
      }
    ],
   },
 "data": [
   {
    "id": 47,
    "object": "message",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 77,
    "group_id": 48,
    "topic_id": 42,
    "body": "",
    "quoted": "",
    "remainder": "",
    "snippet": "",
    "subject": "",
    "name": "",
    "profile_photo_url": "",
    "is_plain_text": false,
    "msg_num": 23,
    "has_liked": false,
    "num_likes": 81,
    "is_closed": false,
    "is_moderated": false,
    "reply_to": "group_reply_only_to_sender",
    "can_repost": false,
    "hashtags": [
      {
       "id": 15,
       "object": "hashtag",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 17,
       "name": "",
       "alias": 
         {
         },
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": false,
       "replies_unmoderated": false,
       "locked": false,
       "until": "hash_tag_delete_day",
       "close_instead_of_delete": false,
       "description": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "reply_to": "thread_reply_group_default",
       "topic_count": 19,
       "last_message_date": "2009-11-10T15:00:00-08:00",
      }
    ],
    "poll_id": 75,
   }
 ],
}

The Oauth Login Object#

The Oauth Login object.

Response Attributes

object string	oauth_login.
state string
web_client_id string	Client ID needed for web applications.
ios_client_id string	Client ID needed for IOS applications.
android_client_id string	Client ID needed for Android applications.
scopes array of string

Methods That Use This Object

Facebook Login Start	View Method
Google Login Start	View Method

Example Response

{
 "object": "oauth_login",
 "state": "12345",
 "web_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "ios_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "android_client_id": "EAAV5drZBzQ3IBALC8Wt86UsiAa0dK95svJU32FQusEIqeHZC",
 "scopes": ["user"],
}

The Pagination Object#

The pagination object is returned with every API response that takes pagination parameters.

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.

Example Response

{
 "object": "list",
 "total_count": 57,
 "start_item": 95,
 "end_item": 50,
 "has_more": false,
 "next_page_token": 19,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
}

The Past Member Object#

The Past Member object contains the information associated with a member subscription that no longer exists. Because a member may be removed from multiple groups at once, the Past Member object may contain multiple member_info objects.

Response Attributes

id integer
object string	past_member.
created string date-time	The time that this record was created.
action string	The reason for the unsubscription. Can be one of: `accepted_invitation`, `added_album`, `added_alias`, `added_dir`, `added_email_integration`, `added_event`, `added_facebook_integration`, `added_file`, `added_github_integration`, `added_hashtag`, `added_instagram_integration`, `added_member`, `added_photo`, `added_repeat_event`, `added_row`, `added_rss_integration`, `added_table`, `added_trello_integration`, `added_wiki_image`, `added_wiki_page`, `applied`, `approved_member`, `approved_pending_message`, `attempt_sub_banned_member`, `attempted_banned_domain_post`, `attempted_banned_domain_registration`, `attempted_file_add_with_virus`, `bad_expired_thread`, `banned_member`, `bounced_user`, `changed_email`, `changed_fullname`, `changed_payer`, `changed_subscription_plan`, `changed_thread_replyto`, `changed_username`, `closed_thread`, `created_group`, `created_subgroup`, `deleted_album`, `deleted_alias`, `deleted_attachment`, `deleted_dir`, `deleted_event`, `deleted_file`, `deleted_following_repeat_event`, `deleted_message`, `deleted_message_edit`, `deleted_pending_message`, `deleted_photo`, `deleted_repeat_event`, `deleted_row`, `deleted_subgroup`, `deleted_table`, `deleted_thread`, `deleted_wiki_image`, `deleted_wiki_page`, `deleted_wiki_rev`, `delivery_changed`, `donation_closed`, `donation_reopened`, `donation_requested`, `donation_updated`, `edited_album`, `edited_email_integration`, `edited_facebook_integration`, `edited_github_integration`, `edited_group`, `edited_group_notices`, `edited_hashtag`, `edited_instagram_integration`, `edited_message`, `edited_message_no_send`, `edited_moderator_note`, `edited_photo`, `edited_rss_integration`, `edited_trello_integration`, `event_rsvp_maybe`, `event_rsvp_no`, `event_rsvp_yes`, `expired_thread`, `exported_group`, `invited_member`, `joined`, `left`, `member_donated`, `member_donation_failed`, `merge_threads`, `mod_changed_email`, `mod_changed_fullname`, `moderated_thread`, `moderator_changed`, `modified_dir`, `modified_event`, `modified_file`, `modified_repeat_event`, `modified_row`, `modified_table`, `modified_wiki_page`, `moved_dir`, `moved_file`, `plan_change`, `poststatus_changed`, `reinvited_member`, `rejected_member`, `rejected_pending_message`, `removed_email_integration`, `removed_facebook_integration`, `removed_github_integration`, `removed_hashtag`, `removed_instagram_integration`, `removed_invite`, `removed_member`, `removed_rss_integration`, `removed_trello_integration`, `reopened_thread`, `resent_confirmation`, `resent_pending_member_notice`, `resumed_membership`, `rotated_photo`, `sent_bounce_probe`, `sent_message_accepted`, `sent_message_announcement`, `sent_message_announcement_password`, `sent_message_attachment_bounced`, `sent_message_banned`, `sent_message_bounced_sub`, `sent_message_cant_add_event`, `sent_message_cant_create_tags`, `sent_message_closed_topic`, `sent_message_mod_only_tags`, `sent_message_moderated`, `sent_message_no_tags`, `sent_message_not_allowed`, `sent_message_not_confirmed_sub`, `sent_message_not_subscriber`, `sent_message_pending_sub`, `sent_message_too_big`, `sent_to_owner`, `spam_left`, `split_thread`, `sticky_thread`, `stripe_account_connected`, `stripe_account_disconnected`, `unbanned_member`, `unbounced_user`, `unmoderated_thread`, `unsticky_thread`, `virus_bounced_member`, `virus_bounced_nonmember`, `virus_moderated`.
member_info Member Info object

Example Response

{
 "id": 60,
 "object": "past_member",
 "created": "2009-11-10T15:00:00-08:00",
 "action": "spamleft",
 "member_info": 
   {
    "id": 76,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 31,
    "group_id": 47,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 90,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 83,
    "pending_subs": 8,
    "pending_msgs": 8,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
}

The Past Member List Object#

The Past Member List object contains a list of Past Member objects.

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Past Member objects

Methods That Use This Object

Get Past Members	View Method

Example Response

{
 "object": "list",
 "total_count": 62,
 "start_item": 87,
 "end_item": 68,
 "has_more": false,
 "next_page_token": 22,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 14,
    "object": "past_member",
    "created": "2009-11-10T15:00:00-08:00",
    "action": "spamleft",
    "member_info": 
      {
       "id": 71,
       "object": "member_info",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 16,
       "group_id": 91,
       "group_name": "mygroup",
       "status": "sub_status_banned",
       "post_status": "sub_poststatus_allowed",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_all",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_large",
       "approved_posts": 38,
       "mod_status": "sub_modstatus_moderator",
       "pending_msg_notify": "sub_notify_email",
       "pending_sub_notify": "sub_notify_email",
       "sub_notify": "sub_notify_email",
       "storage_notify": "sub_notify_email",
       "sub_group_notify": "sub_notify_email",
       "message_report_notify": "sub_notify_email",
       "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
       "owner_msg_notify": "sub_ownermsg_notify_all",
       "email": "joe@example.com",
       "user_status": "user_status_bounced",
       "user_name": "joe",
       "timezone": "America/Los_Angeles",
       "full_name": "Joe Smith",
       "about_me": "",
       "location": "",
       "website": "https://example.com",
       "profile_photo_url": "",
       "profile_privacy": "profile_members",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "",
       "moderator_notes": "",
       "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
       "num_drafts": 54,
       "pending_subs": 94,
       "pending_msgs": 26,
       "perms": 
         {
          "object": "perms",
          "manage_subgroups": false,
          "delete_group": false,
          "download_archives": false,
          "download_entire_group": false,
          "download_members": false,
          "view_activity": false,
          "manage_hashtags": false,
          "manage_integrations": false,
          "manage_group_settings": false,
          "make_moderator": false,
          "manage_member_subscription_options": false,
          "manage_pending_members": false,
          "remove_members": false,
          "ban_members": false,
          "manage_group_billing": false,
          "manage_group_payments": false,
          "edit_archives": false,
          "manage_pending_messages": false,
          "invite_members": false,
          "view_databases": false,
          "can_post": false,
          "can_vote": false,
          "manage_polls": false,
          "view_photos": false,
          "manage_photos": false,
          "manage_members": false,
          "view_calendar": false,
          "manage_calendar": false,
          "view_chats": false,
          "manage_chats": false,
          "view_member_directory": false,
          "view_files": false,
          "manage_files": false,
          "view_members": false,
          "view_wiki": false,
          "manage_wiki": false,
          "manage_subscription": false,
          "public_page": false,
          "sub_page": false,
          "mod_page": false,
          "archives_visible": false,
          "members_visible": false,
          "chat_visible": false,
          "calendar_visible": false,
          "files_visible": false,
          "database_visible": false,
          "photos_visible": false,
          "wiki_visible": false,
          "member_directory_visible": false,
          "hashtags_visible": false,
          "guidelines_visible": false,
          "subgroups_visible": false,
          "open_donations_visible": false,
         },
      },
   }
 ],
}

The Perms Object#

Perms lists all possible Groups.io permissions, and which ones a particular subscription has. There are two 'sets' of things in the permissions object. One set is a more fine grain set of permissions, which describe what actions a subscriber can do. And the second are the _visible flags, which tell you whether a specific area of the group is visible at all. There is some duplication between the two sets.

Response Attributes

object string	perms.
manage_subgroups boolean	Does the user have permission to create and manage subgroups.
delete_group boolean	Does the user have permission to delete the group.
download_archives boolean	Does the user have permission to download the group message archives.
download_entire_group boolean	Does the user have permission to download all aspects of the group.
download_members boolean	Does the user have permission to download the member list.
view_activity boolean	Does the user have permission to view the activity log.
manage_hashtags boolean	Does the user have permission to create and edit hashtags.
manage_integrations boolean	Does the user have permission to manage group integrations, including Github, Trello, Facebook, RSS and Email integrations.
manage_group_settings boolean	Does the user have permission to change group settings, including member notices and cover photos.
make_moderator boolean	Does the user have permission to make another member a moderator.
manage_member_subscription_options boolean	Does the user have permission to change other members' subscription options.
manage_pending_members boolean	Does the user have permission to manage pending member subscriptions.
remove_members boolean	Does the user have permission to remove members from the group.
ban_members boolean	Does the user have permission to ban members from the group.
manage_group_billing boolean	Does the user have permission to make changes to group billing, including upgrading the group, paying for the upgrade, and viewing invoices.
manage_group_payments boolean	Does the user have permission to manage group payments, including setting up donations.
edit_archives boolean	Does the user have permission to edit group messages, including merging topics.
manage_pending_messages boolean	Does the user have permission to approve, deny and reject pending messages.
invite_members boolean	Does the user have permission to invite people to join the group, and for premium groups, to directly add people to the group.
view_databases boolean	Does the user have permission to edit databases.
can_post boolean	Does the user have permission to post messages to the group.
can_vote boolean	Does the user have permission to vote on polls.
manage_polls boolean	Does the user have permission to add or edit polls. The user must have posting privileges, otherwise this will be false.
view_photos boolean	Does the user have permission to view photo albums.
manage_photos boolean	Does the user have permission to create photo albums and upload photos.
manage_members boolean	This is true if any of: `make_moderator`, `remove_members`, `ban_members`, `make_moderator`, `manage_member_subscription_options` are true.
view_calendar boolean	Does the user have permission to view the calendar.
manage_calendar boolean	Does the user have permission to add or edit calendar events.
view_chats boolean	Does the user have permission to view and join chats.
manage_chats boolean	Does the user have permission to create chats.
view_member_directory boolean	Does the user have permission to view the member directory.
view_files boolean	Does the user have permission to view the files section.
manage_files boolean	Does the user have permission to upload and edit files and folders.
view_members boolean	Does the user have permission to view the member and past member lists.
view_wiki boolean	Does the user have permission to view the wiki.
manage_wiki boolean	Does the user have permission to add or edit wiki pages.
manage_subscription boolean	Does the user have permission to edit their subscription.
public_page boolean
sub_page boolean
mod_page boolean
archives_visible boolean	If the group archives are visible.
members_visible boolean	If the members page is visible.
chat_visible boolean	If the chat section is visible.
calendar_visible boolean	If the calendar is visible.
files_visible boolean	If the files section is visible.
database_visible boolean	If the database is visible.
photos_visible boolean	If the photos section is visible.
wiki_visible boolean	If the wiki is visible.
member_directory_visible boolean	If the member directory is visible.
hashtags_visible boolean	If the Hashtags section is visible.
guidelines_visible boolean	Does the user have permission to view the group guidelines.
subgroups_visible boolean	If the subgroups page is visible.
open_donations_visible boolean	If the open donations page is visible.

Methods That Use This Object

Get Permissions	View Method

Example Response

{
 "object": "perms",
 "manage_subgroups": false,
 "delete_group": false,
 "download_archives": false,
 "download_entire_group": false,
 "download_members": false,
 "view_activity": false,
 "manage_hashtags": false,
 "manage_integrations": false,
 "manage_group_settings": false,
 "make_moderator": false,
 "manage_member_subscription_options": false,
 "manage_pending_members": false,
 "remove_members": false,
 "ban_members": false,
 "manage_group_billing": false,
 "manage_group_payments": false,
 "edit_archives": false,
 "manage_pending_messages": false,
 "invite_members": false,
 "view_databases": false,
 "can_post": false,
 "can_vote": false,
 "manage_polls": false,
 "view_photos": false,
 "manage_photos": false,
 "manage_members": false,
 "view_calendar": false,
 "manage_calendar": false,
 "view_chats": false,
 "manage_chats": false,
 "view_member_directory": false,
 "view_files": false,
 "manage_files": false,
 "view_members": false,
 "view_wiki": false,
 "manage_wiki": false,
 "manage_subscription": false,
 "public_page": false,
 "sub_page": false,
 "mod_page": false,
 "archives_visible": false,
 "members_visible": false,
 "chat_visible": false,
 "calendar_visible": false,
 "files_visible": false,
 "database_visible": false,
 "photos_visible": false,
 "wiki_visible": false,
 "member_directory_visible": false,
 "hashtags_visible": false,
 "guidelines_visible": false,
 "subgroups_visible": false,
 "open_donations_visible": false,
}

The Photo Object#

The photo object.

Response Attributes

id integer	Unique ID of the photo object.
object string	photo.
created string date-time
updated string date-time
user_id integer
group_id integer
name string
desc string
media_type string
size number
attachment_num number	If this photo was sent as an attachment, this is the attachment number.
width number
height number
album_id integer
display_name string	Name of the person who uploaded the photo.
user_name string	User name of the person who uploaded the photo.
profile_photo_url string	URL of the profile photo of the person who uploaded the photo.
profile_privacy string	Privacy setting of the person who uploaded the photo.
email string	Possibly obscured, depending on group settings.
format string	Type of image (jpeg, gif, png).
focal_length number	Focal Length, in mm.
iso number	ISO.
aperture number	Aperture, as in f/aperture.
shutter_speed number	Shutter speed, in 1/shutterspeed seconds.
taken number	Time Taken, in Unix seconds since epoch.
make string	Camera make and model.
model string
thumbnail_url string
download_url string

Methods That Use This Object

Get Photo	View Method

Example Response

{
 "id": 25,
 "object": "photo",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 91,
 "group_id": 54,
 "name": "",
 "desc": "",
 "media_type": "image/jpeg",
 "size": 71,
 "attachment_num": 81,
 "width": 67,
 "height": 31,
 "album_id": 24,
 "display_name": "",
 "user_name": "",
 "profile_photo_url": "",
 "profile_privacy": "",
 "email": "",
 "format": "gif",
 "focal_length": 3.2,
 "iso": 52,
 "aperture": 3.2,
 "shutter_speed": 24,
 "taken": 2,
 "make": "",
 "model": "",
 "thumbnail_url": "",
 "download_url": "",
}

The Photo List Object#

Photo List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
album optional Album object	In the case of search results, the Album data is not included.
data array of Photo objects

Methods That Use This Object

Add Photos	View Method
Get Photos	View Method
Search Photos	View Method

Example Response

{
 "object": "list",
 "total_count": 2,
 "start_item": 52,
 "end_item": 61,
 "has_more": false,
 "next_page_token": 74,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "album": 
   {
    "id": 91,
    "object": "album",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 24,
    "group_id": 29,
    "upload_perms": "",
    "title": "",
    "desc": "",
    "cover_photo_thumbnail_url": "",
    "cover_photo_url": "",
    "total_photos": 36,
   },
 "data": [
   {
    "id": 27,
    "object": "photo",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 66,
    "group_id": 57,
    "name": "",
    "desc": "",
    "media_type": "image/jpeg",
    "size": 54,
    "attachment_num": 29,
    "width": 29,
    "height": 76,
    "album_id": 6,
    "display_name": "",
    "user_name": "",
    "profile_photo_url": "",
    "profile_privacy": "",
    "email": "",
    "format": "gif",
    "focal_length": 3.2,
    "iso": 32,
    "aperture": 3.2,
    "shutter_speed": 63,
    "taken": 97,
    "make": "",
    "model": "",
    "thumbnail_url": "",
    "download_url": "",
   }
 ],
}

The Poll Object#

The poll object.

Response Attributes

id integer	Unique ID of the poll object.
object string	poll.
created string date-time
updated string date-time
user_id integer	ID of the person who created the poll.
group_id integer	ID of the group.
profile_photo_url string	If not empty then there is a profile photo associated with this author.
name string	Name of the person who created the poll.
can_view_profile boolean	If the person viewing this poll can view the creator's profile.
question string	Title of poll.
desc string	Description, in HTML.
multiple boolean	If false, only can select one choice.
results_at_end boolean	if true, only display the results at poll close.
never_show_results boolean	if true, members can never see the results (overrides ResultsAtEnd).
answers array of string	The possible answers.
is_closed boolean	if the poll is closed.
msg_num number	Message number of the Message we're associated with. If 0, means the poll hasn't been approved/sent yet.
anonymous boolean	If you cannot see who responded.

Methods That Use This Object

New Poll	View Method
Update Poll	View Method
Get Poll	View Method

Example Response

{
 "id": 21,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 10,
 "group_id": 43,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "answers": [""],
 "is_closed": false,
 "msg_num": 66,
 "anonymous": false,
}

The Poll Answer Object#

The poll answer object.

Response Attributes

answer string	The answer.
count number	How many people voted for this answer.
percentage string	The percentage of total votes for this answer.

Example Response

{
 "answer": "",
 "count": 31,
 "percentage": "",
}

The Poll List Object#

Poll List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Poll objects

Example Response

{
 "object": "list",
 "total_count": 6,
 "start_item": 15,
 "end_item": 7,
 "has_more": false,
 "next_page_token": 70,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 98,
    "object": "poll",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 85,
    "group_id": 88,
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
    "question": "",
    "desc": "",
    "multiple": false,
    "results_at_end": false,
    "never_show_results": false,
    "answers": [""],
    "is_closed": false,
    "msg_num": 89,
    "anonymous": false,
   }
 ],
}

The Poll Results Object#

The poll results object.

Response Attributes

poll_id integer	Unique ID of the poll object.
object string	poll_results.
results array of Poll Answer objects	Results.

Methods That Use This Object

Get Poll Results	View Method

Example Response

{
 "poll_id": 34,
 "object": "poll_results",
 "results": [
   {
    "answer": "",
    "count": 60,
    "percentage": "",
   }
 ],
}

The RSVP Object#

The rsvp object.

Response Attributes

id integer	Unique ID of the rsvp object.
object string	rsvp.
created string date-time	The time that this object was created.
updated string date-time	The time that this object was last updated.
event_id integer	The ID of the associated event object.
group_id integer	The ID of the associated group.
user_id integer	The ID of the person who created this rsvp.
user_name string	The user_name of the person who created this rsvp.
full_name string	The full_name of the person who created this rsvp.
email string	The email address of the person who created this rsvp.
profile_photo_url string
type string	The type of RSVP. Can be one of: `rsvp_maybe`, `rsvp_no`, `rsvp_waitlist`, `rsvp_yes`.
comment string	Some events ask a question of people rsvp'ing. This is that answer.
additional_guests number	Some events allow additional guests.

Methods That Use This Object

RSVP To An Event	View Method

Example Response

{
 "id": 97,
 "object": "rsvp",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "event_id": 89,
 "group_id": 23,
 "user_id": 16,
 "user_name": "",
 "full_name": "",
 "email": "",
 "profile_photo_url": "",
 "type": "rsvp_maybe",
 "comment": "",
 "additional_guests": 32,
}

The Search Result Object#

The topic objecsr.

Response Attributes

id integer
object string	search_result.
created string date-time
updated string date-time
group_id integer
topic_id integer
summary string	Results summary, in HTML.
subject string	Subject of the message.
user_id integer
profile_photo_url string	If not empty then there is a profile photo associated with this author.
name string	Name of the person who created the message.
can_view_profile boolean	If the person viewing this result can view the creator's profile.
rev_count number	If > 0, then this message has been edited.
msg_num number	The msg number of the message, if this is a message.
num_msgs_in_topic number
is_closed boolean	If the topic this message is a part of is closed.
is_moderated boolean	If the topic this message is a part of is moderated.
is_sticky boolean	If this topic has been marked as sticky.
has_attachments boolean	If this message has attachments.
hashtags array of Hashtag objects

Example Response

{
 "id": 49,
 "object": "search_result",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 54,
 "topic_id": 25,
 "summary": "",
 "subject": "",
 "user_id": 97,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "rev_count": 14,
 "msg_num": 54,
 "num_msgs_in_topic": 31,
 "is_closed": false,
 "is_moderated": false,
 "is_sticky": false,
 "has_attachments": false,
 "hashtags": [
   {
    "id": 29,
    "object": "hashtag",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 86,
    "name": "",
    "alias": 
      {
      },
    "mods_only_post": false,
    "mods_only_replies": false,
    "no_email": false,
    "moderated": false,
    "special": false,
    "replies_unmoderated": false,
    "locked": false,
    "until": "hash_tag_delete_day",
    "close_instead_of_delete": false,
    "description": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "reply_to": "thread_reply_group_default",
    "topic_count": 43,
    "last_message_date": "2009-11-10T15:00:00-08:00",
   }
 ],
}

The Search Results List Object#

Search Results List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
group_id integer	ID of the group these results are from.
query string	The query string.
collapse_topics boolean	If the results have collapsed topics.
exclude_sigs boolean	If the results exclude signature matches.
start_date optional string date-time	Optional start date of the search.
end_date optional string date-time	Optional end date of the search.
preset_date_range string	Optional preset date range of the search.
hashtag Hashtag object	If this search is of a hashtag. The hashtag is pulled from the query string.
poster_user_id integer	If this search is limited to a specific poster, this is their user_id. The `poster_profile_photo_url`, `poster_name`, and `can_view_poster_profile` fields are only set if this search is limited to a specific poster. The poster is pulled from the query string.
poster_profile_photo_url string	If not empty then there is a profile photo associated with this poster.
poster_name string	Name of the poster.
can_view_poster_profile boolean	If the person viewing these results can view the poster's profile.
data array of Search Result objects

Methods That Use This Object

Search Archives	View Method

Example Response

{
 "object": "list",
 "total_count": 22,
 "start_item": 40,
 "end_item": 71,
 "has_more": false,
 "next_page_token": 59,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_id": 90,
 "query": "",
 "collapse_topics": false,
 "exclude_sigs": false,
 "start_date": "2009-11-10T15:00:00-08:00",
 "end_date": "2009-11-10T15:00:00-08:00",
 "preset_date_range": "",
 "hashtag": 
   {
    "id": 14,
    "object": "hashtag",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 70,
    "name": "",
    "alias": 
      {
      },
    "mods_only_post": false,
    "mods_only_replies": false,
    "no_email": false,
    "moderated": false,
    "special": false,
    "replies_unmoderated": false,
    "locked": false,
    "until": "hash_tag_delete_day",
    "close_instead_of_delete": false,
    "description": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "reply_to": "thread_reply_group_default",
    "topic_count": 41,
    "last_message_date": "2009-11-10T15:00:00-08:00",
   },
 "poster_user_id": 94,
 "poster_profile_photo_url": "",
 "poster_name": "",
 "can_view_poster_profile": false,
 "data": [
   {
    "id": 95,
    "object": "search_result",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 65,
    "topic_id": 98,
    "summary": "",
    "subject": "",
    "user_id": 86,
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
    "rev_count": 81,
    "msg_num": 50,
    "num_msgs_in_topic": 1,
    "is_closed": false,
    "is_moderated": false,
    "is_sticky": false,
    "has_attachments": false,
    "hashtags": [
      {
       "id": 68,
       "object": "hashtag",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 90,
       "name": "",
       "alias": 
         {
         },
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": false,
       "replies_unmoderated": false,
       "locked": false,
       "until": "hash_tag_delete_day",
       "close_instead_of_delete": false,
       "description": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "reply_to": "thread_reply_group_default",
       "topic_count": 34,
       "last_message_date": "2009-11-10T15:00:00-08:00",
      }
    ],
   }
 ],
}

The Success Object#

The success object.

Response Attributes

object string	success.
extra string

Example Response

{
 "object": "success",
 "extra": "",
}

The Topic Object#

The topic object.

Response Attributes

id integer
object string	topic.
created string date-time
updated string date-time
group_id integer
group_subject_tag string
subject string	Subject of the topic.
summary string	Summary of the first message in the topic.
name string	Name of the originator of the topic.
profile_photo_url string	If not empty then there is a profile photo associated with this author.
num_messages number	Number of messages in the topic.
is_sticky boolean	If the topic is sticky.
is_moderated boolean	If the topic is moderated.
is_closed boolean	If the topic is closed.
has_attachments boolean	If the topic has at least one message that has attachments.
reply_to string	Can be one of: `thread_reply_group_default`, `thread_reply_only_to_sender`, `thread_reply_to_group`, `thread_reply_to_group_and_sender`, `thread_reply_to_moderators`, `thread_reply_to_sender`.
most_recent_message string date-time	Date of the most recent message in the topic.
hashtags array of Hashtag objects

Example Response

{
 "id": 95,
 "object": "topic",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 24,
 "group_subject_tag": "",
 "subject": "",
 "summary": "",
 "name": "",
 "profile_photo_url": "",
 "num_messages": 67,
 "is_sticky": false,
 "is_moderated": false,
 "is_closed": false,
 "has_attachments": false,
 "reply_to": "thread_reply_group_default",
 "most_recent_message": "2009-11-10T15:00:00-08:00",
 "hashtags": [
   {
    "id": 20,
    "object": "hashtag",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 30,
    "name": "",
    "alias": 
      {
      },
    "mods_only_post": false,
    "mods_only_replies": false,
    "no_email": false,
    "moderated": false,
    "special": false,
    "replies_unmoderated": false,
    "locked": false,
    "until": "hash_tag_delete_day",
    "close_instead_of_delete": false,
    "description": "",
    "color_name": "tag_antique_pink",
    "color_hex": "",
    "reply_to": "thread_reply_group_default",
    "topic_count": 64,
    "last_message_date": "2009-11-10T15:00:00-08:00",
   }
 ],
}

The Topic List Object#

Topic List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
group_perms optional Perms object
group optional Group object
sub_data optional array of Member Info objects
data array of Topic objects

Methods That Use This Object

Get Topics	View Method

Example Response

{
 "object": "list",
 "total_count": 77,
 "start_item": 54,
 "end_item": 54,
 "has_more": false,
 "next_page_token": 1,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_perms": 
   {
    "object": "perms",
    "manage_subgroups": false,
    "delete_group": false,
    "download_archives": false,
    "download_entire_group": false,
    "download_members": false,
    "view_activity": false,
    "manage_hashtags": false,
    "manage_integrations": false,
    "manage_group_settings": false,
    "make_moderator": false,
    "manage_member_subscription_options": false,
    "manage_pending_members": false,
    "remove_members": false,
    "ban_members": false,
    "manage_group_billing": false,
    "manage_group_payments": false,
    "edit_archives": false,
    "manage_pending_messages": false,
    "invite_members": false,
    "view_databases": false,
    "can_post": false,
    "can_vote": false,
    "manage_polls": false,
    "view_photos": false,
    "manage_photos": false,
    "manage_members": false,
    "view_calendar": false,
    "manage_calendar": false,
    "view_chats": false,
    "manage_chats": false,
    "view_member_directory": false,
    "view_files": false,
    "manage_files": false,
    "view_members": false,
    "view_wiki": false,
    "manage_wiki": false,
    "manage_subscription": false,
    "public_page": false,
    "sub_page": false,
    "mod_page": false,
    "archives_visible": false,
    "members_visible": false,
    "chat_visible": false,
    "calendar_visible": false,
    "files_visible": false,
    "database_visible": false,
    "photos_visible": false,
    "wiki_visible": false,
    "member_directory_visible": false,
    "hashtags_visible": false,
    "guidelines_visible": false,
    "subgroups_visible": false,
    "open_donations_visible": false,
   },
 "group": 
   {
    "id": 75,
    "object": "group",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "title": "The Example Group",
    "name": "example",
    "nice_group_name": "",
    "alias": "",
    "desc": "This is the description for the example group.",
    "plain_desc": "This is the description for the example group.",
    "subject_tag": "[example]",
    "footer": "",
    "website": "",
    "announce": false,
    "moderated": false,
    "new_users_moderated": false,
    "unmoderate_users_after": 41,
    "restricted": false,
    "allow_non_subs_to_post": false,
    "force_html_emails": false,
    "normalize_html_emails": false,
    "reply_to": "group_reply_only_to_sender",
    "remove_other_reply_options": false,
    "privacy": "group_privacy_archives",
    "seperate_footers": false,
    "allow_downloads": "allow_downloads_by_members",
    "members_visible": "group_view_members_moderators",
    "subgroup_access": "sub_group_moderators",
    "calendar_access": "group_access_limited",
    "files_access": "group_access_limited",
    "database_access": "group_access_limited",
    "wiki_access": "group_access_limited",
    "photos_access": "group_access_limited",
    "member_directory_access": "group_access_limited",
    "polls_access": "polls_access_limited",
    "chat_access": "group_access_limited",
    "handle_attachments": "group_attachments_bounced",
    "plain_text_only": false,
    "handle_virus": "handle_virus_block",
    "locked": false,
    "has_cover_photo": false,
    "has_icon": false,
    "parent_group_id": 19,
    "org_id": 13,
    "max_photo_size_email": "max_photo_size_ex_small",
    "max_photo_size_photos": "max_photo_size_ex_small",
    "max_photo_size_databases": "max_photo_size_ex_small",
    "max_photo_size_wiki_images": "max_photo_size_ex_small",
    "hash_tags_required": false,
    "hash_tag_permissions": "hash_tag_create_mods_bounce",
    "bounce_attachments": false,
    "allow_photos_in_files": false,
    "allow_reposts": false,
    "min_days_between_reposts": 74,
    "max_number_of_reposts": 71,
    "email_delivery_default": "email_delivery_digest",
    "message_selection_default": "message_selection_all",
    "auto_follow_replies_default": false,
    "max_attachment_size_default": "max_attachment_size_large",
    "default_timezone": "",
    "default_time_pref": "military_time",
    "default_date_pref": "international_date",
    "default_monday_start": false,
    "disable_edits": false,
    "disable_no_email": false,
    "auto_close_threads": false,
    "close_threads_after": 77,
    "auto_moderate_threads": false,
    "moderate_threads_after": 11,
    "subgroupcategoryid": 48,
    "subs_count": 63,
    "pending_subs_count": 4,
    "pending_msgs_count": 48,
    "open_chats_count": 19,
    "threads_count": 27,
    "messages_count": 58,
    "org_domain": "",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "cover_photo_url": "",
    "icon_url": "",
    "group_url": "",
    "allow_parent_subs_to_post": false,
    "send_event_summaries": false,
    "event_summary_schedule": "event_summary_monthly",
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
 "sub_data": [
   {
    "id": 20,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 9,
    "group_id": 12,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 94,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 89,
    "pending_subs": 81,
    "pending_msgs": 25,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
 "data": [
   {
    "id": 44,
    "object": "topic",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 81,
    "group_subject_tag": "",
    "subject": "",
    "summary": "",
    "name": "",
    "profile_photo_url": "",
    "num_messages": 40,
    "is_sticky": false,
    "is_moderated": false,
    "is_closed": false,
    "has_attachments": false,
    "reply_to": "thread_reply_group_default",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "hashtags": [
      {
       "id": 38,
       "object": "hashtag",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 83,
       "name": "",
       "alias": 
         {
         },
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": false,
       "replies_unmoderated": false,
       "locked": false,
       "until": "hash_tag_delete_day",
       "close_instead_of_delete": false,
       "description": "",
       "color_name": "tag_antique_pink",
       "color_hex": "",
       "reply_to": "thread_reply_group_default",
       "topic_count": 11,
       "last_message_date": "2009-11-10T15:00:00-08:00",
      }
    ],
   }
 ],
}

The User Object#

The user object.

Response Attributes

id integer
object string	user.
created string date-time
updated string date-time
email string
full_name string
user_name string
timezone string
status string	Can be one of: `user_status_bounced`, `user_status_bouncing`, `user_status_confirmed`, `user_status_inactive`, `user_status_not_confirmed`.
profile_photo_url string
post_pref string
per_page_pref string
allow_facebook_login boolean
allow_google_login boolean
allow_sso_login boolean
csrf_token string
two_factor_enabled boolean
recovery_codes string
dont_munge_message_id boolean	If true, we do not replace the message-id on any messages you send to groups. Replacing the message-id is a way to force Gmail (and others) to display messages you send.
about_me string	Profile stuff.
about_format string
location string
website string
time_pref string
date_pref string
monday_start boolean
profile_privacy string	Who can see this profile.
default_message_view string	The view we go into when viewing messages. Can be one of: `expanded_message_view`, `message_view`, `polls_view`, `thread_view`.
topics_sort_dir string	Sort direction in threads view.
topic_sort_dir string	Sort direction when viewing an individual thread.
messages_sort_dir string	Sort direction in messages view.
expanded_messages_sort_dir string	Sort direction in expanded messages view.
search_sort string	SearchSort is the default sort of search results.
search_sort_dir string	Sort direction in search results (does not apply to RelevanceSort).
photos_order_by string	Sort direction in photos view (albums).
photos_sort_dir string
album_order_by string	Sort direction in photo album view.
album_sort_dir string
home_page string	Which home page to display.
subscriptions optional array of Member Info objects	All of our subscriptions.

Methods That Use This Object

Get User	View Method
Update User	View Method
Update Profile	View Method
Update Profile Photo	View Method
Delete Profile Photo	View Method

Example Response

{
 "id": 65,
 "object": "user",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "email": "user@example.com",
 "full_name": "",
 "user_name": "",
 "timezone": "",
 "status": "user_status_bounced",
 "profile_photo_url": "",
 "post_pref": "",
 "per_page_pref": "",
 "allow_facebook_login": false,
 "allow_google_login": false,
 "allow_sso_login": false,
 "csrf_token": "",
 "two_factor_enabled": false,
 "recovery_codes": "",
 "dont_munge_message_id": false,
 "about_me": "",
 "about_format": "",
 "location": "",
 "website": "",
 "time_pref": "",
 "date_pref": "",
 "monday_start": false,
 "profile_privacy": "",
 "default_message_view": "expanded_message_view",
 "topics_sort_dir": "",
 "topic_sort_dir": "",
 "messages_sort_dir": "",
 "expanded_messages_sort_dir": "",
 "search_sort": "",
 "search_sort_dir": "",
 "photos_order_by": "",
 "photos_sort_dir": "",
 "album_order_by": "",
 "album_sort_dir": "",
 "home_page": "",
 "subscriptions": [
   {
    "id": 52,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 2,
    "group_id": 58,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 73,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 88,
    "pending_subs": 75,
    "pending_msgs": 30,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   }
 ],
}

The Webhook Event Object#

The webhook event object. This represents an action monitored by a webhook_subscription.

Response Attributes

object string	Type of object. Is set to `webhook_event`.
created string date-time	The time this event happened.
webhook_id integer	The ID of the webhook_subscription that triggered this event.
action string	What action took place. Can be one of: `joined`, `created_subgroup`, `deleted_subgroup`.
via string	Through what means the action took place. Can be one of: `via_api`, `via_app`, `via_email`, `via_robot`, `via_slacksync`, `via_support`, `via_web`.
group optional Group object	The group related to the action.
member_info optional Member Info object	The member who did the action. May be omitted.
modded_member_info optional Member Info object	For actions on members, this is the member acted upon. May be omitted.
non_member_email optional string	For actions involving a non-member, this is their email address.

Example Response

{
 "object": "webhook_event",
 "created": "2009-11-10T15:00:00-08:00",
 "webhook_id": 73,
 "action": "created_group",
 "via": "via_web",
 "group": 
   {
    "id": 89,
    "object": "group",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "title": "The Example Group",
    "name": "example",
    "nice_group_name": "",
    "alias": "",
    "desc": "This is the description for the example group.",
    "plain_desc": "This is the description for the example group.",
    "subject_tag": "[example]",
    "footer": "",
    "website": "",
    "announce": false,
    "moderated": false,
    "new_users_moderated": false,
    "unmoderate_users_after": 15,
    "restricted": false,
    "allow_non_subs_to_post": false,
    "force_html_emails": false,
    "normalize_html_emails": false,
    "reply_to": "group_reply_only_to_sender",
    "remove_other_reply_options": false,
    "privacy": "group_privacy_archives",
    "seperate_footers": false,
    "allow_downloads": "allow_downloads_by_members",
    "members_visible": "group_view_members_moderators",
    "subgroup_access": "sub_group_moderators",
    "calendar_access": "group_access_limited",
    "files_access": "group_access_limited",
    "database_access": "group_access_limited",
    "wiki_access": "group_access_limited",
    "photos_access": "group_access_limited",
    "member_directory_access": "group_access_limited",
    "polls_access": "polls_access_limited",
    "chat_access": "group_access_limited",
    "handle_attachments": "group_attachments_bounced",
    "plain_text_only": false,
    "handle_virus": "handle_virus_block",
    "locked": false,
    "has_cover_photo": false,
    "has_icon": false,
    "parent_group_id": 48,
    "org_id": 53,
    "max_photo_size_email": "max_photo_size_ex_small",
    "max_photo_size_photos": "max_photo_size_ex_small",
    "max_photo_size_databases": "max_photo_size_ex_small",
    "max_photo_size_wiki_images": "max_photo_size_ex_small",
    "hash_tags_required": false,
    "hash_tag_permissions": "hash_tag_create_mods_bounce",
    "bounce_attachments": false,
    "allow_photos_in_files": false,
    "allow_reposts": false,
    "min_days_between_reposts": 38,
    "max_number_of_reposts": 87,
    "email_delivery_default": "email_delivery_digest",
    "message_selection_default": "message_selection_all",
    "auto_follow_replies_default": false,
    "max_attachment_size_default": "max_attachment_size_large",
    "default_timezone": "",
    "default_time_pref": "military_time",
    "default_date_pref": "international_date",
    "default_monday_start": false,
    "disable_edits": false,
    "disable_no_email": false,
    "auto_close_threads": false,
    "close_threads_after": 55,
    "auto_moderate_threads": false,
    "moderate_threads_after": 80,
    "subgroupcategoryid": 80,
    "subs_count": 23,
    "pending_subs_count": 98,
    "pending_msgs_count": 85,
    "open_chats_count": 25,
    "threads_count": 12,
    "messages_count": 97,
    "org_domain": "",
    "most_recent_message": "2009-11-10T15:00:00-08:00",
    "cover_photo_url": "",
    "icon_url": "",
    "group_url": "",
    "allow_parent_subs_to_post": false,
    "send_event_summaries": false,
    "event_summary_schedule": "event_summary_monthly",
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
 "member_info": 
   {
    "id": 14,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 18,
    "group_id": 54,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 14,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 50,
    "pending_subs": 62,
    "pending_msgs": 12,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
 "modded_member_info": 
   {
    "id": 84,
    "object": "member_info",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 19,
    "group_id": 35,
    "group_name": "mygroup",
    "status": "sub_status_banned",
    "post_status": "sub_poststatus_allowed",
    "email_delivery": "email_delivery_digest",
    "message_selection": "message_selection_all",
    "auto_follow_replies": false,
    "max_attachment_size": "max_attachment_size_large",
    "approved_posts": 50,
    "mod_status": "sub_modstatus_moderator",
    "pending_msg_notify": "sub_notify_email",
    "pending_sub_notify": "sub_notify_email",
    "sub_notify": "sub_notify_email",
    "storage_notify": "sub_notify_email",
    "sub_group_notify": "sub_notify_email",
    "message_report_notify": "sub_notify_email",
    "mod_permissions": "sub_perm_banmembers,sub_perm_billing",
    "owner_msg_notify": "sub_ownermsg_notify_all",
    "email": "joe@example.com",
    "user_status": "user_status_bounced",
    "user_name": "joe",
    "timezone": "America/Los_Angeles",
    "full_name": "Joe Smith",
    "about_me": "",
    "location": "",
    "website": "https://example.com",
    "profile_photo_url": "",
    "profile_privacy": "profile_members",
    "dont_munge_message_id": false,
    "use_signature": false,
    "use_signature_email": false,
    "signature": "",
    "moderator_notes": "",
    "moderator_notes_updated": "2009-11-10T15:00:00-08:00",
    "num_drafts": 49,
    "pending_subs": 96,
    "pending_msgs": 5,
    "perms": 
      {
       "object": "perms",
       "manage_subgroups": false,
       "delete_group": false,
       "download_archives": false,
       "download_entire_group": false,
       "download_members": false,
       "view_activity": false,
       "manage_hashtags": false,
       "manage_integrations": false,
       "manage_group_settings": false,
       "make_moderator": false,
       "manage_member_subscription_options": false,
       "manage_pending_members": false,
       "remove_members": false,
       "ban_members": false,
       "manage_group_billing": false,
       "manage_group_payments": false,
       "edit_archives": false,
       "manage_pending_messages": false,
       "invite_members": false,
       "view_databases": false,
       "can_post": false,
       "can_vote": false,
       "manage_polls": false,
       "view_photos": false,
       "manage_photos": false,
       "manage_members": false,
       "view_calendar": false,
       "manage_calendar": false,
       "view_chats": false,
       "manage_chats": false,
       "view_member_directory": false,
       "view_files": false,
       "manage_files": false,
       "view_members": false,
       "view_wiki": false,
       "manage_wiki": false,
       "manage_subscription": false,
       "public_page": false,
       "sub_page": false,
       "mod_page": false,
       "archives_visible": false,
       "members_visible": false,
       "chat_visible": false,
       "calendar_visible": false,
       "files_visible": false,
       "database_visible": false,
       "photos_visible": false,
       "wiki_visible": false,
       "member_directory_visible": false,
       "hashtags_visible": false,
       "guidelines_visible": false,
       "subgroups_visible": false,
       "open_donations_visible": false,
      },
   },
 "non_member_email": "",
}

The Webhook Subscription Object#

The webhook subscription object.

Response Attributes

object string	Type of object. Is set to `webhook_subscription`.
created string date-time	The time this subscription was created.
updated string date-time	The last time this subscription was updated.
url string	The URL we are to POST `webhook_event` objects to.
secret string	If specified, `webhook_events` will include a X-Groupsio-Signature header, which is an HMAC hex digest using the sha1 hash function and the `secret` as the HMAC key.
group_ids number	The group monitored by this subscription.
include_subgroups boolean	If monitoring a group, whether to monitor subgroups as well.
actions array of string	The list of actions monitored by this subscription. Can be: `joined`, `added_member`, `created_subgroup`, `deleted_subgroup`.

Methods That Use This Object

Register Webhook Subscription	View Method

Example Response

{
 "object": "webhook_subscription",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "url": "https://example.com/webhook",
 "secret": "blahblahblah",
 "group_ids": 90,
 "include_subgroups": false,
 "actions": ["created_subgroup"],
}

The Wiki Data Object#

The wiki_data object, representing one revision of a wiki page.

Response Attributes

id integer
object string	wiki_data.
created string date-time
updated string date-time
user_id integer
group_id integer
page_id integer
body string	The body of the wiki page, in HTML format.
edit_msg string	Optional edit message.

Example Response

{
 "id": 54,
 "object": "wiki_data",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 28,
 "group_id": 9,
 "page_id": 79,
 "body": "",
 "edit_msg": "",
}

The Wiki Page Object#

The wiki_page object, representing the meta data for a wiki page.

Response Attributes

id integer
object string	wiki_page.
created string date-time
updated string date-time
user_id integer
group_id integer
title string	Title of the wiki page.
path string	Path is Title converted to a wiki page path.
locked boolean
rev_count number	The current revision count of the wiki page.

Example Response

{
 "id": 58,
 "object": "wiki_page",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 60,
 "group_id": 38,
 "title": "",
 "path": "",
 "locked": false,
 "rev_count": 90,
}

The Wiki Page List Object#

Wiki Page List

Response Attributes

object string	list.
total_count number	The total number of items available.
start_item number	The index of the first item, from 0.
end_item number	The index of the last item, from 0.
has_more boolean	Whether there are more items available.
next_page_token number	An opaque token that is to be returned to fetch the next set of objects.
sort_field string	The field to sort on. Valid values are dependent on the call.
second_order string	Optional second order/filter.
query string	If we're paging through search results, this is the search string.
sort_dir string	Sort direction. Can be `asc` or `desc`.
data array of Wiki Page objects

Methods That Use This Object

Get Wiki Pages	View Method

Example Response

{
 "object": "list",
 "total_count": 65,
 "start_item": 9,
 "end_item": 49,
 "has_more": false,
 "next_page_token": 16,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 97,
    "object": "wiki_page",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 75,
    "group_id": 12,
    "title": "",
    "path": "",
    "locked": false,
    "rev_count": 6,
   }
 ],
}

The Wiki Page Set Object#

Wiki Page Set

Response Attributes

page Wiki Page object	The wiki page itself.
data Wiki Data object	The wiki page itself.
sidebar optional Wiki Data object	The optional sidebar.
footer optional Wiki Data object	The optional footer.

Methods That Use This Object

New Wiki Page	View Method
Get Wiki Page Set	View Method

Example Response

{
 "page": 
   {
    "id": 69,
    "object": "wiki_page",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 23,
    "group_id": 6,
    "title": "",
    "path": "",
    "locked": false,
    "rev_count": 32,
   },
 "data": 
   {
    "id": 11,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 26,
    "page_id": 86,
    "body": "",
    "edit_msg": "",
   },
 "sidebar": 
   {
    "id": 45,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 21,
    "group_id": 30,
    "page_id": 78,
    "body": "",
    "edit_msg": "",
   },
 "footer": 
   {
    "id": 8,
    "object": "wiki_data",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 73,
    "group_id": 87,
    "page_id": 37,
    "body": "",
    "edit_msg": "",
   },
}

API Reference - ALPHA

API Endpoints

Versioning And Change Log#

What changes does Groups.io consider to be “backwards-compatible”?

Success#

Errors#

Pagination#

Libraries#

Authentication

Authentication#

Archives

Get Topics#

Get Topic#

Get Messages#

Download Archives#

Search Archives#

Chats

New Chat#

Update Chat#

Get Chats#

Delete Chat#

Join Chat#

Chat Members#

Leave Chat#

Get Chat History#

Chat Data#

Drafts

New Draft#

Update Draft#

Get Drafts#

Delete Draft#

Upload Attachments#

Get Attachments#

Delete Attachment#

Post Draft#

Events

Get Event#

Get Events#

RSVP To An Event#

Feed

Get Feed#

Files

Get File Directory#

Get File#

Search Files#

Add Files#

Group

Create Group#

Create Sub Group#

Get Group Settings#

Get Sub Groups#

Get Group Aliases#

Get Permissions#

Update Group#

Delete Group#

Hashtags

Get Hashtags#

Login

Login#

Logout#

Facebook Login Start#

Facebook Login Final#

Google Login Start#

Google Login Final#

Member Notices

New Member Notice#

Update Member Notice#

Delete Member Notice#

Get Member Notices#

Members

Approve Pending Member#

Ban Member#

Bulk Remove Members#

Direct Add#

Get Member#

Get Members#

Get Past Members#

Remove Member#

Search Members#

Send A Bounce Probe#