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": ""
    }

Extended Return Information

Many endpoints support the extended=true parameter. When this is specified, additional information is returned from the endpoint. The default return for an endpoint is a JSON object, as specified in the documentation. When the extended=true parameter is set, instead a two element JSON array is returned. One element of the array is the original return object. The second element is a User Object.

Libraries

The following are unofficial libraries.

JAVA

github.com/lake54/groupsio-api-java

Authentication

Authentication

Authentication to the API is performed via either HTTP cookies using cookies set from the login API call, which is the default, or via HTTP Basic Auth, using a token received from the login API call when passing in the token parameter. Note, some endpoints, like /facebooklogin, /googlelogin and the chat endpoints require or institute cookie login. All curl examples in the documentation assume cookie authentication.

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

Activity Log

Get Activity Log

Get activity log entries. Entries are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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 "id" and "created".
sort_dir
optional
string

Sort direction. Can be asc or desc.
filter_by
optional
string

Type of log to filter by, can be: member, message, mod, pay.
restrict_date
optional
string

Time period to restrict results by, can be: last_24_hours, last_week, last_30_days, before, after, between.
start_date
optional
string

Start time of the time period specified by restrict_date values of after, between.
end_date
optional
string

End time of the time period specified by restrict_date values of before, between.
action
optional
string

Restrict results to a single activity type.
member_info_id
optional
number

Restrict results to the member.
past_member_info_id
optional
number

Restrict results to the past member.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a Activity Log list object if successful. Returns an error if there is an error.

Additional Errors
"bad_request"

"invalid filter_by" is returned if the filter_by value is invalid.
"bad_request"

"invalid restrict_date" is returned if the restrict_date value is invalid.
"bad_request"

"invalid action" is returned if the action value is invalid.
"bad_request"

"invalid start_date" is returned if the start_date value is invalid.
"bad_request"

"invalid end_date" is returned if the end_date value is invalid.

GET /api/v1/getactivitylog

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

Example Successful Response

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "activity_log",
       "created": "2020-09-04T00:33:00-07:00",
       "group_id": 73387781,
       "entry": "Integration \"testintegration\" sent  special notice #0",
       "via": "via_robot"
     },
     {
       "id": 178561260,
       "object": "activity_log",
       "created": "2020-09-08T11:43:00-07:00",
       "group_id": 73387781,
       "entry": "Integration \"testintegration\" sent  special notice #1",
       "via": "via_robot"
     },
     {
       "id": 174116746,
       "object": "activity_log",
       "created": "2020-09-04T10:02:00-07:00",
       "group_id": 73387781,
       "entry": "Integration \"testintegration\" sent  special notice #2",
       "via": "via_robot"
     }
   ]
}
View Activity Log List definition

Example Error Response

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

Archives

These endpoints deal with the message archives. The archives consist of messages, which are grouped into topics.

Get Topics

Get a group's topics or a user's topics. A topic represents one or more messages in a group. Topics are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a topic 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/gettopics

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

Example Successful Response

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "topic",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "group_id": 73387781,
       "group_subject_tag": "[actually4]",
       "subject": "Them will addition yearly since in these entirely itself whose.",
       "summary": "Rather theirs additionally line to.",
       "name": "Tyshawn Pfannerstill",
       "profile_photo_url": "",
       "num_messages": 18,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "1969-12-31T16:00:00-08:00",
       "hashtags": null
     },
     {
       "id": 132940728,
       "object": "topic",
       "created": "2020-09-20T08:33:00-07:00",
       "updated": "2021-10-28T06:41:00-07:00",
       "group_id": 73387781,
       "group_subject_tag": "[actually4]",
       "subject": "Had does soften anyone anyway then to with wild hourly.",
       "summary": "There she it infrequently power tonight several its.",
       "name": "Emmett Emard",
       "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": "1969-12-31T16:00:00-08:00",
       "hashtags": null
     },
     {
       "id": 105873107,
       "object": "topic",
       "created": "2020-10-01T07:24:00-07:00",
       "updated": "2020-12-04T03:37:00-08:00",
       "group_id": 73387781,
       "group_subject_tag": "[actually4]",
       "subject": "Poor troop frequently dynasty instance dive now door she exemplified.",
       "summary": "Tomato sedge Himalayan has define bale.",
       "name": "Lulu Schimmel",
       "profile_photo_url": "",
       "num_messages": 14,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "1969-12-31T16:00:00-08:00",
       "hashtags": null
     }
   ]
}
View Topic List definition

Example Error Response

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

Get Topic

Get the messages within a specified topic. Messages are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
topic_id
required
number

ID of the topic to return.
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
"bad_request"

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

GET /api/v1/gettopic

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_perms": 
   {
      "object": "perms",
      "archives_visible": true,
      "polls_visible": true,
      "members_visible": true,
      "chat_visible": true,
      "calendar_visible": true,
      "files_visible": true,
      "database_visible": true,
      "photos_visible": true,
      "wiki_visible": true,
      "member_directory_visible": true,
      "hashtags_visible": true,
      "guidelines_visible": true,
      "subgroups_visible": true,
      "open_donations_visible": true,
      "sponsor_visible": true,
      "manage_subgroups": true,
      "delete_group": true,
      "download_archives": true,
      "download_entire_group": true,
      "download_members": true,
      "view_activity": true,
      "create_hashtags": true,
      "manage_hashtags": true,
      "manage_integrations": true,
      "manage_group_settings": true,
      "make_moderator": true,
      "manage_member_subscription_options": true,
      "manage_pending_members": true,
      "remove_members": true,
      "ban_members": true,
      "manage_group_billing": true,
      "manage_group_payments": true,
      "edit_archives": true,
      "manage_pending_messages": true,
      "invite_members": true,
      "can_post": true,
      "can_vote": true,
      "manage_polls": true,
      "manage_photos": true,
      "manage_members": true,
      "manage_calendar": true,
      "manage_chats": true,
      "view_member_directory": true,
      "manage_files": true,
      "manage_wiki": true,
      "manage_subscription": true,
      "public_page": true,
      "sub_page": true,
      "mod_page": true
   },
 "group": 
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   },
 "cover_photo_url": "",
 "sub_data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
 "topic": 
   {
      "id": 131773379,
      "object": "topic",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "group_id": 73387781,
      "group_subject_tag": "[actually4]",
      "subject": "Them will addition yearly since in these entirely itself whose.",
      "summary": "Rather theirs additionally line to say.",
      "name": "Ladarius Swaniawski",
      "profile_photo_url": "",
      "num_messages": 27,
      "is_sticky": false,
      "is_moderated": false,
      "is_closed": false,
      "has_attachments": false,
      "reply_to": "thread_reply_group_default",
      "most_recent_message": "1969-12-31T16:00:00-08:00",
      "hashtags": null
   },
 "data": [
   {
    "id": 63,
    "object": "message",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 47,
    "topic_id": 78,
    "body": "",
    "quoted": "",
    "remainder": "",
    "snippet": "",
    "subject": "",
    "subject_with_tags": "",
    "name": "",
    "profile_photo_url": "",
    "is_plain_text": false,
    "msg_num": 24,
    "is_reply": false,
    "has_liked": false,
    "num_likes": 59,
    "is_closed": false,
    "is_moderated": false,
    "reply_to": "group_reply_only_to_sender",
    "can_repost": false,
    "hashtags": [
      {
         "id": 1758,
         "object": "hashtag",
         "created": "2020-09-16T20:58:00-07:00",
         "group_id": 903,
         "name": "Barney Parisian",
         "mods_only_post": true,
         "mods_only_replies": false,
         "no_email": true,
         "moderated": true,
         "special": true,
         "replies_unmoderated": false,
         "locked": true,
         "until": "hashtag_delete_month",
         "close_instead_of_delete": false,
         "description": "Them will addition yearly since in these entirely itself.",
         "color_name": "bluejean",
         "color_hex": "#8ec2ee",
         "reply_to": "thread_reply_to_sender",
         "topic_count": 1162,
         "last_message_date": "2020-09-28T03:08:00-07:00",
         "muted": null,
         "followed": null
      }
    ],
    "poll_id": 2,
    "attachments": [
      {
       "id": 63,
       "media_type": "",
       "download_url": "",
       "image_thumbnail_url": "",
       "filename": "",
      }
    ],
   }
 ],
}
View Message List definition

Example Error Response

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

Get Messages

Get the messages within a specified group. Messages are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

GET /api/v1/getmessages

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_perms": 
   {
      "object": "perms",
      "archives_visible": true,
      "polls_visible": true,
      "members_visible": true,
      "chat_visible": true,
      "calendar_visible": true,
      "files_visible": true,
      "database_visible": true,
      "photos_visible": true,
      "wiki_visible": true,
      "member_directory_visible": true,
      "hashtags_visible": true,
      "guidelines_visible": true,
      "subgroups_visible": true,
      "open_donations_visible": true,
      "sponsor_visible": true,
      "manage_subgroups": true,
      "delete_group": true,
      "download_archives": true,
      "download_entire_group": true,
      "download_members": true,
      "view_activity": true,
      "create_hashtags": true,
      "manage_hashtags": true,
      "manage_integrations": true,
      "manage_group_settings": true,
      "make_moderator": true,
      "manage_member_subscription_options": true,
      "manage_pending_members": true,
      "remove_members": true,
      "ban_members": true,
      "manage_group_billing": true,
      "manage_group_payments": true,
      "edit_archives": true,
      "manage_pending_messages": true,
      "invite_members": true,
      "can_post": true,
      "can_vote": true,
      "manage_polls": true,
      "manage_photos": true,
      "manage_members": true,
      "manage_calendar": true,
      "manage_chats": true,
      "view_member_directory": true,
      "manage_files": true,
      "manage_wiki": true,
      "manage_subscription": true,
      "public_page": true,
      "sub_page": true,
      "mod_page": true
   },
 "group": 
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   },
 "cover_photo_url": "",
 "sub_data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
 "topic": 
   {
      "id": 131773379,
      "object": "topic",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "group_id": 73387781,
      "group_subject_tag": "[actually4]",
      "subject": "Them will addition yearly since in these entirely itself whose.",
      "summary": "Rather theirs additionally line to say.",
      "name": "Ladarius Swaniawski",
      "profile_photo_url": "",
      "num_messages": 27,
      "is_sticky": false,
      "is_moderated": false,
      "is_closed": false,
      "has_attachments": false,
      "reply_to": "thread_reply_group_default",
      "most_recent_message": "1969-12-31T16:00:00-08:00",
      "hashtags": null
   },
 "data": [
   {
    "id": 63,
    "object": "message",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 47,
    "topic_id": 78,
    "body": "",
    "quoted": "",
    "remainder": "",
    "snippet": "",
    "subject": "",
    "subject_with_tags": "",
    "name": "",
    "profile_photo_url": "",
    "is_plain_text": false,
    "msg_num": 24,
    "is_reply": false,
    "has_liked": false,
    "num_likes": 59,
    "is_closed": false,
    "is_moderated": false,
    "reply_to": "group_reply_only_to_sender",
    "can_repost": false,
    "hashtags": [
      {
         "id": 1758,
         "object": "hashtag",
         "created": "2020-09-16T20:58:00-07:00",
         "group_id": 903,
         "name": "Barney Parisian",
         "mods_only_post": true,
         "mods_only_replies": false,
         "no_email": true,
         "moderated": true,
         "special": true,
         "replies_unmoderated": false,
         "locked": true,
         "until": "hashtag_delete_month",
         "close_instead_of_delete": false,
         "description": "Them will addition yearly since in these entirely itself.",
         "color_name": "bluejean",
         "color_hex": "#8ec2ee",
         "reply_to": "thread_reply_to_sender",
         "topic_count": 1162,
         "last_message_date": "2020-09-28T03:08:00-07:00",
         "muted": null,
         "followed": null
      }
    ],
    "poll_id": 2,
    "attachments": [
      {
       "id": 63,
       "media_type": "",
       "download_url": "",
       "image_thumbnail_url": "",
       "filename": "",
      }
    ],
   }
 ],
}
View Message List definition

Example Error Response

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

Download Archives

Download Archives Download the archives of a group.

Permissions Needed

You must have the download_archives permission to use this call.

Query Parameters
group_id
required
number

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.
start_msg_num
optional
number

Only returns messages with a message number greater than this number.
start_time
optional
date

Only returns messages more recently than this date. In format: 2020-01-25T15:30:15Z.
Returns

Returns an error if the parameters are invalid (e.g. specifying an invalid group id).

Additional Errors
"bad_request"

"invalid start_time format" is returned if the start_time parameter is not formatted correctly.
Notes
  • The archives will be returned as a .zip file, containing one file in mbox format.
  • This is a resource intensive call and may take some time to complete. This API call may be changed in the future to a webhook.
  • This call is rate limited to one call per person per group every 24 hours.

GET /api/v1/downloadarchives

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

Example Error Response

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

Search Archives

Search the archives. The query string can include the following:

  • Limiting the search to specific hashtags can be done by include the hashtag names in the query, starting with #.
  • To exclude specific hashtags, include a dash before the hashtag, like: -#Tagname. Note, this is not currently implemented in the API.
  • Limiting the search to a specific person's messages can be done by including the text posterid:ID, where ID is the user_id of the person.
Permissions Needed

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

Query Parameters
group_id
required
number

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
date

The start date of the search, in the user's timezone.
end_date
optional
date

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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 relevance and created.
sort_dir
optional
string

Sort direction. Can be asc or desc.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

GET /api/v1/searcharchives

$ curl "https://groups.io/api/v1/searcharchives?group_id=12&q=find+this" \
-b "cookies.curl"

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "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": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   },
 "poster_user_id": 2,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "data": [
   {
    "id": 63,
    "object": "message_search_result",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "topic_id": 47,
    "summary": "",
    "subject": "",
    "body": "",
    "user_id": 78,
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
    "rev_count": 24,
    "msg_num": 59,
    "num_msgs_in_topic": 53,
    "is_closed": false,
    "is_moderated": false,
    "is_sticky": false,
    "has_attachments": false,
    "hashtags": [
      {
         "id": 1758,
         "object": "hashtag",
         "created": "2020-09-16T20:58:00-07:00",
         "group_id": 903,
         "name": "Barney Parisian",
         "mods_only_post": true,
         "mods_only_replies": false,
         "no_email": true,
         "moderated": true,
         "special": true,
         "replies_unmoderated": false,
         "locked": true,
         "until": "hashtag_delete_month",
         "close_instead_of_delete": false,
         "description": "Them will addition yearly since in these entirely itself.",
         "color_name": "bluejean",
         "color_hex": "#8ec2ee",
         "reply_to": "thread_reply_to_sender",
         "topic_count": 1162,
         "last_message_date": "2020-09-28T03:08:00-07:00",
         "muted": null,
         "followed": null
      }
    ],
   }
 ],
}
View Message Search Results List definition

Example Error Response

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

Get Message History

Get the message history.

Permissions Needed

None.

Query Parameters
group_id
optional
number

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.
offset
optional
number

Timezone offset, in minutes.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a message history 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.

GET /api/v1/getmessagehistory

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

Example Successful Response

 {
 "object": "message_history",
 "month_counts": [
   {
    "object": "month_count",
    "year": 63,
    "month": 33,
    "msgs_sent": 47,
   }
 ],
 "tz_offset": 78,
}
View Message History definition

Example Error Response

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

Chats

There are several aspects to the Chat system.

  1. The Chat object represents a chat.
  2. 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
number

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

 {
   "id": 131773379,
   "object": "chat",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "profile_photo_url": "",
   "name": "",
   "can_view_profile": false,
   "group_id": 73387781,
   "subject": "Example.",
   "desc": "Will addition yearly.",
   "is_closed": false,
   "num_messages": 91,
   "chat_sub": {
     "id": 172646701,
     "object": "chat_sub",
     "created": "2020-09-20T18:09:00-07:00",
     "updated": "2022-09-22T09:25:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "chat_id": 131773379,
     "last_msg_seen": 157
   }
}
View Chat definition

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
number

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

 {
   "id": 131773379,
   "object": "chat",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "profile_photo_url": "",
   "name": "",
   "can_view_profile": false,
   "group_id": 73387781,
   "subject": "Example.",
   "desc": "Will addition yearly.",
   "is_closed": false,
   "num_messages": 91,
   "chat_sub": {
     "id": 172646701,
     "object": "chat_sub",
     "created": "2020-09-20T18:09:00-07:00",
     "updated": "2022-09-22T09:25:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "chat_id": 131773379,
     "last_msg_seen": 157
   }
}
View Chat definition

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 chat_visible permission to use this call with a group.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "chat",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 73387781,
       "subject": "Example.",
       "desc": "Will addition yearly.",
       "is_closed": false,
       "num_messages": 91,
       "chat_sub": {
         "id": 172646701,
         "object": "chat_sub",
         "created": "2020-09-07T18:08:00-07:00",
         "updated": "2022-09-25T00:35:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "chat_id": 131773379,
         "last_msg_seen": 157
       }
     },
     {
       "id": 87372696,
       "object": "chat",
       "created": "2020-09-30T14:36:00-07:00",
       "updated": "2022-06-29T13:41:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 73387781,
       "subject": "These.",
       "desc": "Entirely itself whose.",
       "is_closed": false,
       "num_messages": 61,
       "chat_sub": {
         "id": 155987616,
         "object": "chat_sub",
         "created": "2020-09-30T19:43:00-07:00",
         "updated": "2021-11-02T19:38:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "chat_id": 87372696,
         "last_msg_seen": 36
       }
     },
     {
       "id": 142876175,
       "object": "chat",
       "created": "2020-09-05T18:43:00-07:00",
       "updated": "2023-06-07T13:03:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 73387781,
       "subject": "Additionally.",
       "desc": "Line to say.",
       "is_closed": false,
       "num_messages": 63,
       "chat_sub": {
         "id": 179936620,
         "object": "chat_sub",
         "created": "2020-09-01T06:41:00-07:00",
         "updated": "2022-09-10T10:23:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "chat_id": 142876175,
         "last_msg_seen": 193
       }
     }
   ]
}
View Chat List definition

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
number

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.

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 chat_visible permission to use this call with a group.

POST Parameters
chat_id
required
number

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

 {
   "id": 172646701,
   "object": "chat_sub",
   "created": "2020-09-20T18:09:00-07:00",
   "updated": "2022-09-22T09:25:00-07:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "chat_id": 131773379,
   "last_msg_seen": 157
}
View Chat Sub definition

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
number

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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Member Info List definition

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
number

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.

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
number

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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 172646701,
       "object": "chat_message",
       "created": "2020-09-07T18:08:00-07:00",
       "version": 2,
       "user_id": 147779411,
       "group_id": 73387781,
       "chat_id": 131773379,
       "historical": false,
       "type": "chat_msg_type_normal",
       "message": "In.",
       "msg_num": 0,
       "delete_msg_num": 0,
       "photo_width": 0,
       "photo_height": 0,
       "tapbacks": null,
       "tapback_counts": null,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 126702543,
       "object": "chat_message",
       "created": "2020-09-30T19:43:00-07:00",
       "version": 2,
       "user_id": 147779411,
       "group_id": 73387781,
       "chat_id": 98794901,
       "historical": false,
       "type": "chat_msg_type_normal",
       "message": "Contrast.",
       "msg_num": 0,
       "delete_msg_num": 0,
       "photo_width": 0,
       "photo_height": 0,
       "tapbacks": null,
       "tapback_counts": null,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 889509,
       "object": "chat_message",
       "created": "2020-09-01T06:41:00-07:00",
       "version": 2,
       "user_id": 147779411,
       "group_id": 73387781,
       "chat_id": 155038277,
       "historical": false,
       "type": "chat_msg_type_normal",
       "message": "Yesterday.",
       "msg_num": 0,
       "delete_msg_num": 0,
       "photo_width": 0,
       "photo_height": 0,
       "tapbacks": null,
       "tapback_counts": null,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     }
   ]
}
View Chat Message List definition

Example Error Response

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

Databases

Get Databases

Get databases. Databases are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
No additional errors

GET /api/v1/getdatabases

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "databasetable",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "user_id": 47,
    "name": "",
    "short_desc": "",
    "desc": "",
    "desc_type": "",
    "edit_table": "database_access_all",
    "edit_rows": "database_access_all",
    "add_rows": "database_access_all",
    "view_table": "database_access_all",
    "num_rows": 78,
    "max_row_id": 24,
    "num_columns": 59,
    "max_col_id": 53,
    "display_template": "",
    "columns": [
      {
         "id": 131773379,
         "name": "Example will addition yearly since.",
         "type": "multiple_choice",
         "required": true,
         "color": "color_moss_green",
         "choices": [
           "Nervously string lastly advertising faithfully it.",
           "Later depend deeply everybody rhythm for.",
           "Had does soften anyone anyway then."
         ],
         "width": 0,
         "default_hidden": false,
         "description": "In these entirely itself whose rather theirs additionally line to."
      }
    ],
    "id_default_hidden": false,
    "updated_default_hidden": false,
   }
 ],
}
View Database Table List definition

Example Error Response

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

Get Database Rows

Get database rows. Database rows are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
database_id
required
number

ID of the database.
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a database row list object if successful. Returns an error if there is an error.

Additional Errors
No additional errors

GET /api/v1/getdatabaserows

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "databaserow",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "table_id": 47,
    "row_num": 78,
    "vals": [
      {
       "col_id": 63,
       "col_type": "address",
       "text": "",
       "html_text": "",
       "date": "2009-11-10T15:00:00-08:00",
       "time": "2009-11-10T15:00:00-08:00",
       "checked": false,
       "multi_choice": [33],
       "street_address1": "",
       "street_address2": "",
       "city": "",
       "state": "",
       "zip": "",
       "country": "",
       "lat": "",
       "lng": "",
       "title": "",
       "url": "",
       "desc": "",
       "image_name": "",
       "number": "",
      }
    ],
    "num_vals": 47,
   }
 ],
}
View Database Row List definition

Example Error Response

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

Delivery

Get Delivery Info

Get a user's group specific delivery information.

Permissions Needed

None if viewing your own delivery information. If viewing another member's delivery information, you need the manage_members permission.

Query Parameters
group_id
optional
number

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.
member_info_id
optional
number

If specified, return the delivery information for this member. You must have the manage_members permission to specify this.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a delivery info 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.

GET /api/v1/getdeliveryinfo

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

Example Successful Response

 {
 "object": "delivery_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 63,
 "success_msg_id": 33,
 "success_time": "2009-11-10T15:00:00-08:00",
 "success_subject": "",
 "success_type": "delivery_bounce_probe",
 "success_response": "",
 "attempt_msg_id": 47,
 "attempt_time": "2009-11-10T15:00:00-08:00",
 "attempt_subject": "",
 "attempt_type": "delivery_bounce_probe",
 "attempt_response": "",
 "bounces": [
   {
    "object": "bounce_info",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 63,
    "msg_id": 33,
    "subject": "",
    "response": "",
    "is_hard": false,
    "type": "delivery_bounce_probe",
   }
 ],
}
View Delivery Info definition

Example Error Response

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

Get Bounce Info

Get a user's bounce information.

Permissions Needed

None.

Query Parameters
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a bounce info 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

None.

GET /api/v1/getbounceinfo

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "bounce_info",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 63,
    "msg_id": 33,
    "subject": "",
    "response": "",
    "is_hard": false,
    "type": "delivery_bounce_probe",
   }
 ],
}
View Bounce Info List definition

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:

  1. Create a new draft with /newdraft.
  2. Compose the message, periodically saving it with /updatedraft.
  3. Optionally add attachments, using /addattachments.
  4. 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
number

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, draft_type_reply, draft_type_post_to_sub and draft_type_dm are the only allowed types.
csrf
required
string

The csrf_token from the user object returned when first logged in.
message_id
may be required
number

If this is a 'draft_type_reply', you must specify the ID of the message you are replying to.
dm_member_id
may be required
number

If this is a draft_type_dm, you must specify the ID of the member you are sending a message to.
member_id
may be required
number

If this is a draft_type_post_to_sub, you must specify the ID of the member you are sending a message to. You can specify more than one member_ids.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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.
"bad_request"

"missing dm_member_id" is returned if the draft type is draft_type_dm and dm_member_id is missing.

POST /api/v1/newdraft

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

Example Successful Response

 {
 "id": 63,
 "object": "draft",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "draft_type": "",
 "subject": "",
 "body": "",
 "body_type": "",
 "is_special": false,
 "num_attachments": 78,
 "next_attachment_id": 24,
 "message_id": 59,
 "bcc_me": false,
 "bcc_all": false,
}
View Draft definition

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
number

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).
is_private
optional
boolean

If the private button has been toggled.
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).
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "id": 63,
 "object": "draft",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "draft_type": "",
 "subject": "",
 "body": "",
 "body_type": "",
 "is_special": false,
 "num_attachments": 78,
 "next_attachment_id": 24,
 "message_id": 59,
 "bcc_me": false,
 "bcc_all": false,
}
View Draft definition

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
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "draft",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 47,
    "draft_type": "",
    "subject": "",
    "body": "",
    "body_type": "",
    "is_special": false,
    "num_attachments": 78,
    "next_attachment_id": 24,
    "message_id": 59,
    "bcc_me": false,
    "bcc_all": false,
   }
 ],
}
View Draft List definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "draft_attachment",
    "draft_id": 33,
    "url": "",
    "filename": "",
    "size": 47,
    "content_type": "",
    "inline": false,
   }
 ],
}
View Draft Attachment List definition

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
number

ID of the draft containing the attachments. You must be the owner of the draft.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "draft_attachment",
    "draft_id": 33,
    "url": "",
    "filename": "",
    "size": 47,
    "content_type": "",
    "inline": false,
   }
 ],
}
View Draft Attachment List definition

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
number

ID of the draft containing the attachment to delete. You must be the owner of the draft.
attachment_id
required
number

Attachment ID to delete.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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
number

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.
reply
optional
string

Only applicable if this draft is a reply to a message. Possible values are: sender, group_and_sender, mods.
from_owner
optional
boolean

Only applicable if this draft is a new post and the poster is a moderator or owner of the group. If true, send the post from the groupname+owner email address.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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"

"group out of space" is returned if the group is out of space.
"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.
"bad_request"

"invalid reply" is returned if the reply parameter is invalid.

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
number

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. extended - optional, boolean: If true, the endpoint will return additional information. See Extended Return Information for more information.

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

 {
 "id": 63,
 "object": "event",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "creator_name": "@JohnSmith",
 "group_id": 33,
 "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": "color_antique_pink",
 "color_hex": "",
 "rsvp": false,
 "max_attendees": 47,
 "additional_guests": false,
 "comment_label": "",
 "yes_message": "",
 "has_rsvp": false,
 "rsvp_type": "",
 "rsvp_comment": "",
 "rsvp_additional_guests": 78,
}
View Event definition

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
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

GET /api/v1/getevents

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "event",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "creator_name": "@JohnSmith",
    "group_id": 33,
    "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": "color_antique_pink",
    "color_hex": "",
    "rsvp": false,
    "max_attendees": 47,
    "additional_guests": false,
    "comment_label": "",
    "yes_message": "",
    "has_rsvp": false,
    "rsvp_type": "",
    "rsvp_comment": "",
    "rsvp_additional_guests": 78,
   }
 ],
}
View Event List definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "id": 63,
 "object": "rsvp",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "event_id": 33,
 "group_id": 47,
 "user_id": 78,
 "user_name": "",
 "full_name": "",
 "email": "",
 "profile_photo_url": "",
 "type": "rsvp_maybe",
 "comment": "",
 "additional_guests": 24,
}
View RSVP definition

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
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

GET /api/v1/getfeed

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "feed",
    "member_info": 
      {
         "id": 93518468,
         "object": "member_info",
         "created": "2020-09-05T13:57:00-07:00",
         "updated": "2023-02-12T13:06:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "group_name": "actually4",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_single",
         "message_selection": "message_selection_all",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_unlimited",
         "approved_posts": 0,
         "mod_status": "sub_modstatus_owner",
         "pending_msg_notify": "sub_notify_email_and_app",
         "pending_sub_notify": "sub_notify_email_and_app",
         "sub_notify": "sub_notify_email_and_app",
         "storage_notify": "sub_notify_email_and_app",
         "sub_group_notify": "sub_notify_email_and_app",
         "message_report_notify": "sub_notify_email_and_app",
         "account_notify": "sub_notify_email_and_app",
         "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
         "owner_msg_notify": "sub_ownermsg_notify_subs",
         "chat_notify": "sub_notify_email_and_app",
         "photo_notify": "sub_notify_email_and_app",
         "file_notify": "sub_notify_email_and_app",
         "wiki_notify": "sub_notify_email_and_app",
         "database_notify": "sub_notify_email_and_app",
         "email": "gersonbeahan@jacobi.io",
         "user_status": "user_status_confirmed",
         "user_name": "Dickens6041",
         "timezone": "America/Chicago",
         "full_name": "Lawson Kreiger",
         "about_me": "Today awfully arrive at",
         "location": "Well away onto",
         "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "Growth one album",
         "color": "color_cerulean_blue",
         "cover_photo_url": "",
         "icon_url": "",
         "nice_group_name": "",
         "subs_count": 0,
         "most_recent_message": "0001-01-01T00:00:00Z",
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "extra_member_data": [
           {
             "col_id": 184312747,
             "col_type": "text",
             "text": "Other openly practically why gun it scold far hourly formerly."
           },
           {
             "col_id": 130018632,
             "col_type": "paragraph",
             "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
           },
           {
             "col_id": 158522530,
             "col_type": "checkbox",
             "checked": false
           },
           {
             "col_id": 77272575,
             "col_type": "multiple_choice"
           },
           {
             "col_id": 199150300,
             "col_type": "date",
             "date": "0001-01-01T00:00:00Z"
           },
           {
             "col_id": 139937550,
             "col_type": "time",
             "time": "1919-04-03T21:05:37.017498068Z"
           },
           {
             "col_id": 35163253,
             "col_type": "address",
             "street_address1": "56235 Club ton",
             "street_address2": "772 Port Valleys stad",
             "city": "Chandler",
             "state": "Nebraska",
             "zip": "58231",
             "country": "Gibraltar"
           },
           {
             "col_id": 22148015,
             "col_type": "multi_choice"
           },
           {
             "col_id": 23015426,
             "col_type": "link",
             "title": "Philippine before throughout wander of as there next of sleep.",
             "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
             "desc": "Cap today am terribly many because anyone does you hungrily."
           },
           {
             "col_id": 166687029,
             "col_type": "image",
             "url": "https://picsum.photos/id/83/200/300",
             "image_name": "Eastern with herself muster monthly it party another his ours."
           },
           {
             "col_id": 172741244,
             "col_type": "html_paragraph",
             "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
           }
         ]
      },
    "group": 
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      },
    "topics": [
      {
       "topic": 
         {
            "id": 131773379,
            "object": "topic",
            "created": "2020-09-02T18:27:00-07:00",
            "updated": "2021-01-10T20:19:00-08:00",
            "group_id": 73387781,
            "group_subject_tag": "[actually4]",
            "subject": "Them will addition yearly since in these entirely itself whose.",
            "summary": "Rather theirs additionally line to say.",
            "name": "Ladarius Swaniawski",
            "profile_photo_url": "",
            "num_messages": 27,
            "is_sticky": false,
            "is_moderated": false,
            "is_closed": false,
            "has_attachments": false,
            "reply_to": "thread_reply_group_default",
            "most_recent_message": "1969-12-31T16:00:00-08:00",
            "hashtags": null
         },
       "images": [
         {
          "id": "",
          "object": "attachment",
          "created": "2009-11-10T15:00:00-08:00",
          "group_id": 63,
          "user_id": 33,
          "thread_id": 47,
          "message_num": 78,
          "attach_num": 24,
          "type": "",
          "sub_type": "",
          "name": "",
          "content": "",
          "image_width": 59,
          "image_height": 53,
          "thumbnail_url": "",
         }
       ],
      }
    ],
    "events": [
      {
       "id": 63,
       "object": "event",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "creator_name": "@JohnSmith",
       "group_id": 33,
       "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": "color_antique_pink",
       "color_hex": "",
       "rsvp": false,
       "max_attendees": 47,
       "additional_guests": false,
       "comment_label": "",
       "yes_message": "",
       "has_rsvp": false,
       "rsvp_type": "",
       "rsvp_comment": "",
       "rsvp_additional_guests": 78,
      }
    ],
    "files": [
      {
         "id": 131773379,
         "object": "file",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "name": "Seth White",
         "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
         "size": 197000002,
         "path": "topfolder/subfolder",
         "parent_folder_id": 0,
         "is_folder": false,
         "type": "file_type_file",
         "count": 2,
         "media_type": "text/plain",
         "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
         "display_name": "Lawson Kreiger",
         "user_name": "Dickens6041",
         "profile_photo_url": "",
         "profile_privacy": "profile_private",
         "email": "gersonbeahan@..."
      }
    ],
    "photos": [
      {
         "id": 893,
         "object": "photo",
         "created": "2020-09-07T18:08:00-07:00",
         "updated": "2022-09-25T00:35:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "name": "Theirs additionally line",
         "desc": "To say poorly out according.",
         "media_type": "image/jpg",
         "size": 4060156,
         "attachment_num": 0,
         "width": 0,
         "height": 0,
         "album_id": 131773379,
         "display_name": "Lawson Kreiger",
         "user_name": "Dickens6041",
         "profile_privacy": "profile_private",
         "email": "gersonbeahan@...",
         "format": "jpeg",
         "focal_length": 0,
         "iso": 0,
         "aperture": 0,
         "shutter_speed": 0,
         "taken": 0,
         "make": "",
         "model": ""
      }
    ],
    "chats": [
      {
         "id": 131773379,
         "object": "chat",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "user_id": 147779411,
         "profile_photo_url": "",
         "name": "",
         "can_view_profile": false,
         "group_id": 73387781,
         "subject": "Example.",
         "desc": "Will addition yearly.",
         "is_closed": false,
         "num_messages": 91,
         "chat_sub": {
           "id": 172646701,
           "object": "chat_sub",
           "created": "2020-09-20T18:09:00-07:00",
           "updated": "2022-09-22T09:25:00-07:00",
           "user_id": 147779411,
           "group_id": 73387781,
           "chat_id": 131773379,
           "last_msg_seen": 157
         }
      }
    ],
    "wikis": [
      {
         "id": 131773379,
         "object": "wiki_page",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "title": "Example will addition yearly since",
         "path": "Example-will-addition-yearly-since",
         "locked": false,
         "rev_count": 22
      }
    ],
    "subgroups": [
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      }
    ],
    "tables": [
      {
       "id": 63,
       "object": "databasetable",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "group_id": 33,
       "user_id": 47,
       "name": "",
       "short_desc": "",
       "desc": "",
       "desc_type": "",
       "edit_table": "database_access_all",
       "edit_rows": "database_access_all",
       "add_rows": "database_access_all",
       "view_table": "database_access_all",
       "num_rows": 78,
       "max_row_id": 24,
       "num_columns": 59,
       "max_col_id": 53,
       "display_template": "",
       "columns": [
         {
            "id": 131773379,
            "name": "Example will addition yearly since.",
            "type": "multiple_choice",
            "required": true,
            "color": "color_moss_green",
            "choices": [
              "Nervously string lastly advertising faithfully it.",
              "Later depend deeply everybody rhythm for.",
              "Had does soften anyone anyway then."
            ],
            "width": 0,
            "default_hidden": false,
            "description": "In these entirely itself whose rather theirs additionally line to."
         }
       ],
       "id_default_hidden": false,
       "updated_default_hidden": false,
      }
    ],
    "hashtags": [
      {
         "id": 1758,
         "object": "hashtag",
         "created": "2020-09-16T20:58:00-07:00",
         "group_id": 903,
         "name": "Barney Parisian",
         "mods_only_post": true,
         "mods_only_replies": false,
         "no_email": true,
         "moderated": true,
         "special": true,
         "replies_unmoderated": false,
         "locked": true,
         "until": "hashtag_delete_month",
         "close_instead_of_delete": false,
         "description": "Them will addition yearly since in these entirely itself.",
         "color_name": "bluejean",
         "color_hex": "#8ec2ee",
         "reply_to": "thread_reply_to_sender",
         "topic_count": 1162,
         "last_message_date": "2020-09-28T03:08:00-07:00",
         "muted": null,
         "followed": null
      }
    ],
   }
 ],
}
View Feed List definition

Example Error Response

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

Get Single Feed

Get a single feed object for a group.

Query Parameters
group_id
required
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

GET /api/v1/getsinglefeed

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

Example Successful Response

 {
 "object": "feed",
 "member_info": 
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   },
 "group": 
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   },
 "topics": [
   {
    "topic": 
      {
         "id": 131773379,
         "object": "topic",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "group_id": 73387781,
         "group_subject_tag": "[actually4]",
         "subject": "Them will addition yearly since in these entirely itself whose.",
         "summary": "Rather theirs additionally line to say.",
         "name": "Ladarius Swaniawski",
         "profile_photo_url": "",
         "num_messages": 27,
         "is_sticky": false,
         "is_moderated": false,
         "is_closed": false,
         "has_attachments": false,
         "reply_to": "thread_reply_group_default",
         "most_recent_message": "1969-12-31T16:00:00-08:00",
         "hashtags": null
      },
    "images": [
      {
       "id": "",
       "object": "attachment",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 63,
       "user_id": 33,
       "thread_id": 47,
       "message_num": 78,
       "attach_num": 24,
       "type": "",
       "sub_type": "",
       "name": "",
       "content": "",
       "image_width": 59,
       "image_height": 53,
       "thumbnail_url": "",
      }
    ],
   }
 ],
 "events": [
   {
    "id": 63,
    "object": "event",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "creator_name": "@JohnSmith",
    "group_id": 33,
    "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": "color_antique_pink",
    "color_hex": "",
    "rsvp": false,
    "max_attendees": 47,
    "additional_guests": false,
    "comment_label": "",
    "yes_message": "",
    "has_rsvp": false,
    "rsvp_type": "",
    "rsvp_comment": "",
    "rsvp_additional_guests": 78,
   }
 ],
 "files": [
   {
      "id": 131773379,
      "object": "file",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "name": "Seth White",
      "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
      "size": 197000002,
      "path": "topfolder/subfolder",
      "parent_folder_id": 0,
      "is_folder": false,
      "type": "file_type_file",
      "count": 2,
      "media_type": "text/plain",
      "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
      "display_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "profile_photo_url": "",
      "profile_privacy": "profile_private",
      "email": "gersonbeahan@..."
   }
 ],
 "photos": [
   {
      "id": 893,
      "object": "photo",
      "created": "2020-09-07T18:08:00-07:00",
      "updated": "2022-09-25T00:35:00-07:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "name": "Theirs additionally line",
      "desc": "To say poorly out according.",
      "media_type": "image/jpg",
      "size": 4060156,
      "attachment_num": 0,
      "width": 0,
      "height": 0,
      "album_id": 131773379,
      "display_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "profile_privacy": "profile_private",
      "email": "gersonbeahan@...",
      "format": "jpeg",
      "focal_length": 0,
      "iso": 0,
      "aperture": 0,
      "shutter_speed": 0,
      "taken": 0,
      "make": "",
      "model": ""
   }
 ],
 "chats": [
   {
      "id": 131773379,
      "object": "chat",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "user_id": 147779411,
      "profile_photo_url": "",
      "name": "",
      "can_view_profile": false,
      "group_id": 73387781,
      "subject": "Example.",
      "desc": "Will addition yearly.",
      "is_closed": false,
      "num_messages": 91,
      "chat_sub": {
        "id": 172646701,
        "object": "chat_sub",
        "created": "2020-09-20T18:09:00-07:00",
        "updated": "2022-09-22T09:25:00-07:00",
        "user_id": 147779411,
        "group_id": 73387781,
        "chat_id": 131773379,
        "last_msg_seen": 157
      }
   }
 ],
 "wikis": [
   {
      "id": 131773379,
      "object": "wiki_page",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "title": "Example will addition yearly since",
      "path": "Example-will-addition-yearly-since",
      "locked": false,
      "rev_count": 22
   }
 ],
 "subgroups": [
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   }
 ],
 "tables": [
   {
    "id": 63,
    "object": "databasetable",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "user_id": 47,
    "name": "",
    "short_desc": "",
    "desc": "",
    "desc_type": "",
    "edit_table": "database_access_all",
    "edit_rows": "database_access_all",
    "add_rows": "database_access_all",
    "view_table": "database_access_all",
    "num_rows": 78,
    "max_row_id": 24,
    "num_columns": 59,
    "max_col_id": 53,
    "display_template": "",
    "columns": [
      {
         "id": 131773379,
         "name": "Example will addition yearly since.",
         "type": "multiple_choice",
         "required": true,
         "color": "color_moss_green",
         "choices": [
           "Nervously string lastly advertising faithfully it.",
           "Later depend deeply everybody rhythm for.",
           "Had does soften anyone anyway then."
         ],
         "width": 0,
         "default_hidden": false,
         "description": "In these entirely itself whose rather theirs additionally line to."
      }
    ],
    "id_default_hidden": false,
    "updated_default_hidden": false,
   }
 ],
 "hashtags": [
   {
      "id": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   }
 ],
}
View Feed definition

Example Error Response

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

Files

These are the API endpoints for directories and files.

Add Files

Add files or a folder of files.

Permissions Needed

You must have permission to add files to the folder.

Query Parameters
group_id
required
number

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.
parent_folder_id
required
number

ID of the folder to add the files to, or 0 if the top-level.
desc
optional
string

Description of the file or of the folder.
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.
file_path
optional
strings

If is_folder is true, for each file there should be a file_path variable, specifying the path of the file within the directory being uploaded.
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.
"bad_request"

"no space" is returned if the group is out of space.
"bad_request"

"file too big" is returned if the file is too large.
"bad_request"

"images not allowed" is returned if an image is uploaded to the files section of the group that does not allow images in the files section.
"bad_request"

"duplicate file" is returned if the name of the file matches another file in the same folder.

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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 131773379,
       "object": "file",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Seth White",
       "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
       "size": 197000002,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 92742948,
       "object": "file",
       "created": "2020-09-07T18:08:00-07:00",
       "updated": "2022-09-25T00:35:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Burnice Rau",
       "desc": "Another fly she it infrequently power tonight several its which.",
       "size": 3477666,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/92742948/Burnice%20Rau?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=wp2UWrODAbzJ0oMC9jrlMHYKnEc%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 65238498,
       "object": "file",
       "created": "2020-09-30T14:36:00-07:00",
       "updated": "2022-06-29T13:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Maximillia Gottlieb",
       "desc": "Hourly him Polynesian nose guitar government whose example congregation backwards.",
       "size": 135468236,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/65238498/Maximillia%20Gottlieb?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=fxgvdcZT%2Bvi%2BHVhYX2jwRnZA%2BMQ%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}
View File List definition

Example Error Response

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

Get File Directory

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

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
No additional errors
Notes

GET /api/v1/getfiledirectory

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

Example Successful Response

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 131773379,
       "object": "file",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Seth White",
       "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
       "size": 197000002,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 92742948,
       "object": "file",
       "created": "2020-09-07T18:08:00-07:00",
       "updated": "2022-09-25T00:35:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Burnice Rau",
       "desc": "Another fly she it infrequently power tonight several its which.",
       "size": 3477666,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/92742948/Burnice%20Rau?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=wp2UWrODAbzJ0oMC9jrlMHYKnEc%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 65238498,
       "object": "file",
       "created": "2020-09-30T14:36:00-07:00",
       "updated": "2022-06-29T13:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Maximillia Gottlieb",
       "desc": "Hourly him Polynesian nose guitar government whose example congregation backwards.",
       "size": 135468236,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/65238498/Maximillia%20Gottlieb?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=fxgvdcZT%2Bvi%2BHVhYX2jwRnZA%2BMQ%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}
View File List definition

Example Error Response

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

Get File

Get file.

Permissions Needed

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

Query Parameters
group_id
required
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
No additional errors
Notes

GET /api/v1/getfile

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

Example Successful Response

 {
   "id": 131773379,
   "object": "file",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "name": "Seth White",
   "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
   "size": 197000002,
   "path": "topfolder/subfolder",
   "parent_folder_id": 0,
   "is_folder": false,
   "type": "file_type_file",
   "count": 2,
   "media_type": "text/plain",
   "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_photo_url": "",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@..."
}
View File definition

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 files_visible permission to use this call with a group.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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.
Notes

GET /api/v1/searchfiles

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

Example Successful Response

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 131773379,
       "object": "file",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Seth White",
       "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
       "size": 197000002,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 92742948,
       "object": "file",
       "created": "2020-09-07T18:08:00-07:00",
       "updated": "2022-09-25T00:35:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Burnice Rau",
       "desc": "Another fly she it infrequently power tonight several its which.",
       "size": 3477666,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/92742948/Burnice%20Rau?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=wp2UWrODAbzJ0oMC9jrlMHYKnEc%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 65238498,
       "object": "file",
       "created": "2020-09-30T14:36:00-07:00",
       "updated": "2022-06-29T13:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Maximillia Gottlieb",
       "desc": "Hourly him Polynesian nose guitar government whose example congregation backwards.",
       "size": 135468236,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/65238498/Maximillia%20Gottlieb?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=fxgvdcZT%2Bvi%2BHVhYX2jwRnZA%2BMQ%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}
View File List definition

Example Error Response

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

Delete File

Delete file.

Permissions Needed

You must have permission to edit a file.

Query Parameters
group_id
required
number

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.
file_id
required
number

ID of the file to delete.
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 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 url" is returned if the URL is missing or invalid.
"bad_request"

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

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

"duplicate file" is returned if the name of the link matches another file in the same folder.

POST /api/v1/deletefile

$ curl "https://groups.io/api/v1/deletefile" \
-b "cookies.curl"
-F file_id=2 \
-F "csrf=12345"

Example Successful Response

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 131773379,
       "object": "file",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Seth White",
       "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
       "size": 197000002,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 92742948,
       "object": "file",
       "created": "2020-09-07T18:08:00-07:00",
       "updated": "2022-09-25T00:35:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Burnice Rau",
       "desc": "Another fly she it infrequently power tonight several its which.",
       "size": 3477666,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/92742948/Burnice%20Rau?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=wp2UWrODAbzJ0oMC9jrlMHYKnEc%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 65238498,
       "object": "file",
       "created": "2020-09-30T14:36:00-07:00",
       "updated": "2022-06-29T13:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Maximillia Gottlieb",
       "desc": "Hourly him Polynesian nose guitar government whose example congregation backwards.",
       "size": 135468236,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/65238498/Maximillia%20Gottlieb?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=fxgvdcZT%2Bvi%2BHVhYX2jwRnZA%2BMQ%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}
View File List definition

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
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
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 73387781,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "actually4",
   "nice_group_name": "",
   "alias": "",
   "desc": "This is a test group",
   "plain_desc": "This is a test group",
   "subject_tag": "[actually4]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "allow_non_subs_to_post": false,
   "force_html_emails": false,
   "normalize_html_emails": false,
   "reply_to": "group_reply_to_group",
   "remove_other_reply_options": false,
   "privacy": "group_privacy_none",
   "seperate_footers": false,
   "allow_downloads": "allow_downloads_no",
   "members_visible": "group_view_members_moderators",
   "sub_group_access": "sub_group_subs",
   "calendar_access": "group_access_subscribers",
   "files_access": "group_access_subscribers",
   "database_access": "group_access_subscribers",
   "wiki_access": "group_access_subscribers",
   "photos_access": "group_access_subscribers",
   "member_directory_access": "group_access_subscribers",
   "polls_access": "polls_access_subscribers",
   "chat_access": "group_access_subscribers",
   "handle_attachments": "group_attachments_normal",
   "plain_text_only": false,
   "handle_virus": "handle_virus_block",
   "locked": false,
   "plan": "group_plan_premium",
   "trial_group": false,
   "has_cover_photo": false,
   "has_icon": false,
   "parent_group_id": 0,
   "org_id": 1,
   "max_photo_size_email": "max_photo_size_none",
   "max_photo_size_photos": "max_photo_size_none",
   "max_photo_size_databases": "max_photo_size_none",
   "max_photo_size_wiki_images": "max_photo_size_none",
   "hash_tags_required": false,
   "hash_tag_permissions": "hash_tag_create_subs",
   "bounce_attachments": false,
   "allow_photos_in_files": false,
   "allow_reposts": false,
   "min_days_between_reposts": 0,
   "max_number_of_reposts": 0,
   "email_delivery_default": "email_delivery_single",
   "message_selection_default": "message_selection_all",
   "auto_follow_replies_default": false,
   "max_attachment_size_default": "max_attachment_size_small",
   "default_color": "color_cerulean_blue",
   "default_timezone": "America/Los_Angeles",
   "default_time_pref": "standard_time",
   "default_date_pref": "us_date",
   "default_monday_start": false,
   "disable_edits": false,
   "disable_no_email": false,
   "auto_close_threads": false,
   "close_threads_after": 0,
   "auto_moderate_threads": false,
   "moderate_threads_after": 0,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 361,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "1969-12-31T16: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_weekly_friday",
   "send_invites_on_join": false,
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "email_address": "actually4@groups.io",
   "extra_member_data_columns": [
     {
       "id": 184312747,
       "name": "Collection dream week that be.",
       "type": "text",
       "required": true,
       "color": "color_mulbery",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "So which archipelago wicked along width whom exaltation himself how."
     },
     {
       "id": 130018632,
       "name": "These execute toast whose have.",
       "type": "paragraph",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Why themselves the huge been we something honesty sing as."
     },
     {
       "id": 158522530,
       "name": "Whom whose heap been regularly.",
       "type": "checkbox",
       "required": true,
       "color": "color_lilac",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Build in this how today nearly carrot are near right."
     },
     {
       "id": 77272575,
       "name": "Onion of how product write.",
       "type": "multiple_choice",
       "required": true,
       "color": "color_cloudy_blue",
       "choices": [
         "Covey range window silence lastly had.",
         "What outcome let while school pause.",
         "Up anxiously today whom itself sleep."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Point week doctor movement whose also it vanish watch these."
     },
     {
       "id": 199150300,
       "name": "Quarterly outfit faithful is often.",
       "type": "date",
       "required": true,
       "color": "color_green_lantern",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Part whom these been hourly then smell then under lastly."
     },
     {
       "id": 139937550,
       "name": "Besides pack when murder her.",
       "type": "time",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Had snore first in limp through first open towards besides."
     },
     {
       "id": 35163253,
       "name": "Black monthly ball upon almost.",
       "type": "address",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
     },
     {
       "id": 22148015,
       "name": "Orchard what far upon which.",
       "type": "multi_choice",
       "required": true,
       "color": "color_orange",
       "choices": [
         "Cheese at kiss rarely each her.",
         "Ski ours host our as did.",
         "They to money such this as."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "These bale nobody few how anyone these string life that."
     },
     {
       "id": 23015426,
       "name": "Regularly nearby twist how time.",
       "type": "link",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Yourselves hungry those right empty none another what full her."
     },
     {
       "id": 166687029,
       "name": "Mob nose his me much.",
       "type": "image",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Bathe whoever afterwards myself mine to his how woman no."
     },
     {
       "id": 172741244,
       "name": "Half am yesterday must why.",
       "type": "html_paragraph",
       "required": true,
       "color": "color_none",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
     }
   ]
}
View Group definition

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
number

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
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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.
"bad_request"

"group does not support subgroups" is returned if the group is a free 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

 {
   "id": 73387781,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "actually4",
   "nice_group_name": "",
   "alias": "",
   "desc": "This is a test group",
   "plain_desc": "This is a test group",
   "subject_tag": "[actually4]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "allow_non_subs_to_post": false,
   "force_html_emails": false,
   "normalize_html_emails": false,
   "reply_to": "group_reply_to_group",
   "remove_other_reply_options": false,
   "privacy": "group_privacy_none",
   "seperate_footers": false,
   "allow_downloads": "allow_downloads_no",
   "members_visible": "group_view_members_moderators",
   "sub_group_access": "sub_group_subs",
   "calendar_access": "group_access_subscribers",
   "files_access": "group_access_subscribers",
   "database_access": "group_access_subscribers",
   "wiki_access": "group_access_subscribers",
   "photos_access": "group_access_subscribers",
   "member_directory_access": "group_access_subscribers",
   "polls_access": "polls_access_subscribers",
   "chat_access": "group_access_subscribers",
   "handle_attachments": "group_attachments_normal",
   "plain_text_only": false,
   "handle_virus": "handle_virus_block",
   "locked": false,
   "plan": "group_plan_premium",
   "trial_group": false,
   "has_cover_photo": false,
   "has_icon": false,
   "parent_group_id": 0,
   "org_id": 1,
   "max_photo_size_email": "max_photo_size_none",
   "max_photo_size_photos": "max_photo_size_none",
   "max_photo_size_databases": "max_photo_size_none",
   "max_photo_size_wiki_images": "max_photo_size_none",
   "hash_tags_required": false,
   "hash_tag_permissions": "hash_tag_create_subs",
   "bounce_attachments": false,
   "allow_photos_in_files": false,
   "allow_reposts": false,
   "min_days_between_reposts": 0,
   "max_number_of_reposts": 0,
   "email_delivery_default": "email_delivery_single",
   "message_selection_default": "message_selection_all",
   "auto_follow_replies_default": false,
   "max_attachment_size_default": "max_attachment_size_small",
   "default_color": "color_cerulean_blue",
   "default_timezone": "America/Los_Angeles",
   "default_time_pref": "standard_time",
   "default_date_pref": "us_date",
   "default_monday_start": false,
   "disable_edits": false,
   "disable_no_email": false,
   "auto_close_threads": false,
   "close_threads_after": 0,
   "auto_moderate_threads": false,
   "moderate_threads_after": 0,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 361,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "1969-12-31T16: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_weekly_friday",
   "send_invites_on_join": false,
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "email_address": "actually4@groups.io",
   "extra_member_data_columns": [
     {
       "id": 184312747,
       "name": "Collection dream week that be.",
       "type": "text",
       "required": true,
       "color": "color_mulbery",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "So which archipelago wicked along width whom exaltation himself how."
     },
     {
       "id": 130018632,
       "name": "These execute toast whose have.",
       "type": "paragraph",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Why themselves the huge been we something honesty sing as."
     },
     {
       "id": 158522530,
       "name": "Whom whose heap been regularly.",
       "type": "checkbox",
       "required": true,
       "color": "color_lilac",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Build in this how today nearly carrot are near right."
     },
     {
       "id": 77272575,
       "name": "Onion of how product write.",
       "type": "multiple_choice",
       "required": true,
       "color": "color_cloudy_blue",
       "choices": [
         "Covey range window silence lastly had.",
         "What outcome let while school pause.",
         "Up anxiously today whom itself sleep."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Point week doctor movement whose also it vanish watch these."
     },
     {
       "id": 199150300,
       "name": "Quarterly outfit faithful is often.",
       "type": "date",
       "required": true,
       "color": "color_green_lantern",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Part whom these been hourly then smell then under lastly."
     },
     {
       "id": 139937550,
       "name": "Besides pack when murder her.",
       "type": "time",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Had snore first in limp through first open towards besides."
     },
     {
       "id": 35163253,
       "name": "Black monthly ball upon almost.",
       "type": "address",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
     },
     {
       "id": 22148015,
       "name": "Orchard what far upon which.",
       "type": "multi_choice",
       "required": true,
       "color": "color_orange",
       "choices": [
         "Cheese at kiss rarely each her.",
         "Ski ours host our as did.",
         "They to money such this as."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "These bale nobody few how anyone these string life that."
     },
     {
       "id": 23015426,
       "name": "Regularly nearby twist how time.",
       "type": "link",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Yourselves hungry those right empty none another what full her."
     },
     {
       "id": 166687029,
       "name": "Mob nose his me much.",
       "type": "image",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Bathe whoever afterwards myself mine to his how woman no."
     },
     {
       "id": 172741244,
       "name": "Half am yesterday must why.",
       "type": "html_paragraph",
       "required": true,
       "color": "color_none",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
     }
   ]
}
View Group definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

GET /api/v1/getgroup

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

Example Successful Response

 {
   "id": 73387781,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "actually4",
   "nice_group_name": "",
   "alias": "",
   "desc": "This is a test group",
   "plain_desc": "This is a test group",
   "subject_tag": "[actually4]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "allow_non_subs_to_post": false,
   "force_html_emails": false,
   "normalize_html_emails": false,
   "reply_to": "group_reply_to_group",
   "remove_other_reply_options": false,
   "privacy": "group_privacy_none",
   "seperate_footers": false,
   "allow_downloads": "allow_downloads_no",
   "members_visible": "group_view_members_moderators",
   "sub_group_access": "sub_group_subs",
   "calendar_access": "group_access_subscribers",
   "files_access": "group_access_subscribers",
   "database_access": "group_access_subscribers",
   "wiki_access": "group_access_subscribers",
   "photos_access": "group_access_subscribers",
   "member_directory_access": "group_access_subscribers",
   "polls_access": "polls_access_subscribers",
   "chat_access": "group_access_subscribers",
   "handle_attachments": "group_attachments_normal",
   "plain_text_only": false,
   "handle_virus": "handle_virus_block",
   "locked": false,
   "plan": "group_plan_premium",
   "trial_group": false,
   "has_cover_photo": false,
   "has_icon": false,
   "parent_group_id": 0,
   "org_id": 1,
   "max_photo_size_email": "max_photo_size_none",
   "max_photo_size_photos": "max_photo_size_none",
   "max_photo_size_databases": "max_photo_size_none",
   "max_photo_size_wiki_images": "max_photo_size_none",
   "hash_tags_required": false,
   "hash_tag_permissions": "hash_tag_create_subs",
   "bounce_attachments": false,
   "allow_photos_in_files": false,
   "allow_reposts": false,
   "min_days_between_reposts": 0,
   "max_number_of_reposts": 0,
   "email_delivery_default": "email_delivery_single",
   "message_selection_default": "message_selection_all",
   "auto_follow_replies_default": false,
   "max_attachment_size_default": "max_attachment_size_small",
   "default_color": "color_cerulean_blue",
   "default_timezone": "America/Los_Angeles",
   "default_time_pref": "standard_time",
   "default_date_pref": "us_date",
   "default_monday_start": false,
   "disable_edits": false,
   "disable_no_email": false,
   "auto_close_threads": false,
   "close_threads_after": 0,
   "auto_moderate_threads": false,
   "moderate_threads_after": 0,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 361,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "1969-12-31T16: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_weekly_friday",
   "send_invites_on_join": false,
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "email_address": "actually4@groups.io",
   "extra_member_data_columns": [
     {
       "id": 184312747,
       "name": "Collection dream week that be.",
       "type": "text",
       "required": true,
       "color": "color_mulbery",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "So which archipelago wicked along width whom exaltation himself how."
     },
     {
       "id": 130018632,
       "name": "These execute toast whose have.",
       "type": "paragraph",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Why themselves the huge been we something honesty sing as."
     },
     {
       "id": 158522530,
       "name": "Whom whose heap been regularly.",
       "type": "checkbox",
       "required": true,
       "color": "color_lilac",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Build in this how today nearly carrot are near right."
     },
     {
       "id": 77272575,
       "name": "Onion of how product write.",
       "type": "multiple_choice",
       "required": true,
       "color": "color_cloudy_blue",
       "choices": [
         "Covey range window silence lastly had.",
         "What outcome let while school pause.",
         "Up anxiously today whom itself sleep."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Point week doctor movement whose also it vanish watch these."
     },
     {
       "id": 199150300,
       "name": "Quarterly outfit faithful is often.",
       "type": "date",
       "required": true,
       "color": "color_green_lantern",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Part whom these been hourly then smell then under lastly."
     },
     {
       "id": 139937550,
       "name": "Besides pack when murder her.",
       "type": "time",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Had snore first in limp through first open towards besides."
     },
     {
       "id": 35163253,
       "name": "Black monthly ball upon almost.",
       "type": "address",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
     },
     {
       "id": 22148015,
       "name": "Orchard what far upon which.",
       "type": "multi_choice",
       "required": true,
       "color": "color_orange",
       "choices": [
         "Cheese at kiss rarely each her.",
         "Ski ours host our as did.",
         "They to money such this as."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "These bale nobody few how anyone these string life that."
     },
     {
       "id": 23015426,
       "name": "Regularly nearby twist how time.",
       "type": "link",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Yourselves hungry those right empty none another what full her."
     },
     {
       "id": 166687029,
       "name": "Mob nose his me much.",
       "type": "image",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Bathe whoever afterwards myself mine to his how woman no."
     },
     {
       "id": 172741244,
       "name": "Half am yesterday must why.",
       "type": "html_paragraph",
       "required": true,
       "color": "color_none",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
     }
   ]
}
View Group definition

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
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 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 .
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

GET /api/v1/getsubgroups

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   }
 ],
}
View Group List definition

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
number

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

New name for the group. If this is a subgroup, this needs to be of the form parentName+subName.
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
sub_group_access
optional
string

Who has permission to create sub groups. For groups with subgroups, only settable on the parent group. Possible values are: 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_color
optional
string

Default color for member subscriptions.
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.
allow_parent_subs_to_post
optional
boolean
send_event_summaries
optional
boolean

If true, and a premium group, a summary email of upcoming events is sent out regularly.
event_summary_schedule
optional
string

Can be event_summary_weekly_friday, event_summary_monthly, event_summary_biweekly_friday.
send_invites_on_join
optional
boolean

If true, and a premium group, invites to all calendar events will be sent to new users, and a set of cancel events will be sent to users when they leave.
lock_group
optional
boolean

If true, and a premium group, locks the group, preventing any additional changes.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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.
  • A group that is not restricted cannot have a members_visible value of group_view_members_subs, unless it is a subgroup and the parent group is restricted.

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

 {
   "id": 73387781,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "actually4",
   "nice_group_name": "",
   "alias": "",
   "desc": "This is a test group",
   "plain_desc": "This is a test group",
   "subject_tag": "[actually4]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "allow_non_subs_to_post": false,
   "force_html_emails": false,
   "normalize_html_emails": false,
   "reply_to": "group_reply_to_group",
   "remove_other_reply_options": false,
   "privacy": "group_privacy_none",
   "seperate_footers": false,
   "allow_downloads": "allow_downloads_no",
   "members_visible": "group_view_members_moderators",
   "sub_group_access": "sub_group_subs",
   "calendar_access": "group_access_subscribers",
   "files_access": "group_access_subscribers",
   "database_access": "group_access_subscribers",
   "wiki_access": "group_access_subscribers",
   "photos_access": "group_access_subscribers",
   "member_directory_access": "group_access_subscribers",
   "polls_access": "polls_access_subscribers",
   "chat_access": "group_access_subscribers",
   "handle_attachments": "group_attachments_normal",
   "plain_text_only": false,
   "handle_virus": "handle_virus_block",
   "locked": false,
   "plan": "group_plan_premium",
   "trial_group": false,
   "has_cover_photo": false,
   "has_icon": false,
   "parent_group_id": 0,
   "org_id": 1,
   "max_photo_size_email": "max_photo_size_none",
   "max_photo_size_photos": "max_photo_size_none",
   "max_photo_size_databases": "max_photo_size_none",
   "max_photo_size_wiki_images": "max_photo_size_none",
   "hash_tags_required": false,
   "hash_tag_permissions": "hash_tag_create_subs",
   "bounce_attachments": false,
   "allow_photos_in_files": false,
   "allow_reposts": false,
   "min_days_between_reposts": 0,
   "max_number_of_reposts": 0,
   "email_delivery_default": "email_delivery_single",
   "message_selection_default": "message_selection_all",
   "auto_follow_replies_default": false,
   "max_attachment_size_default": "max_attachment_size_small",
   "default_color": "color_cerulean_blue",
   "default_timezone": "America/Los_Angeles",
   "default_time_pref": "standard_time",
   "default_date_pref": "us_date",
   "default_monday_start": false,
   "disable_edits": false,
   "disable_no_email": false,
   "auto_close_threads": false,
   "close_threads_after": 0,
   "auto_moderate_threads": false,
   "moderate_threads_after": 0,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 361,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "1969-12-31T16: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_weekly_friday",
   "send_invites_on_join": false,
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "email_address": "actually4@groups.io",
   "extra_member_data_columns": [
     {
       "id": 184312747,
       "name": "Collection dream week that be.",
       "type": "text",
       "required": true,
       "color": "color_mulbery",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "So which archipelago wicked along width whom exaltation himself how."
     },
     {
       "id": 130018632,
       "name": "These execute toast whose have.",
       "type": "paragraph",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Why themselves the huge been we something honesty sing as."
     },
     {
       "id": 158522530,
       "name": "Whom whose heap been regularly.",
       "type": "checkbox",
       "required": true,
       "color": "color_lilac",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Build in this how today nearly carrot are near right."
     },
     {
       "id": 77272575,
       "name": "Onion of how product write.",
       "type": "multiple_choice",
       "required": true,
       "color": "color_cloudy_blue",
       "choices": [
         "Covey range window silence lastly had.",
         "What outcome let while school pause.",
         "Up anxiously today whom itself sleep."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Point week doctor movement whose also it vanish watch these."
     },
     {
       "id": 199150300,
       "name": "Quarterly outfit faithful is often.",
       "type": "date",
       "required": true,
       "color": "color_green_lantern",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Part whom these been hourly then smell then under lastly."
     },
     {
       "id": 139937550,
       "name": "Besides pack when murder her.",
       "type": "time",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Had snore first in limp through first open towards besides."
     },
     {
       "id": 35163253,
       "name": "Black monthly ball upon almost.",
       "type": "address",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
     },
     {
       "id": 22148015,
       "name": "Orchard what far upon which.",
       "type": "multi_choice",
       "required": true,
       "color": "color_orange",
       "choices": [
         "Cheese at kiss rarely each her.",
         "Ski ours host our as did.",
         "They to money such this as."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "These bale nobody few how anyone these string life that."
     },
     {
       "id": 23015426,
       "name": "Regularly nearby twist how time.",
       "type": "link",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Yourselves hungry those right empty none another what full her."
     },
     {
       "id": 166687029,
       "name": "Mob nose his me much.",
       "type": "image",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Bathe whoever afterwards myself mine to his how woman no."
     },
     {
       "id": 172741244,
       "name": "Half am yesterday must why.",
       "type": "html_paragraph",
       "required": true,
       "color": "color_none",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
     }
   ]
}
View Group definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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": ""
 }

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

GET /api/v1/getperms

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

Example Successful Response

 {
   "object": "perms",
   "archives_visible": true,
   "polls_visible": true,
   "members_visible": true,
   "chat_visible": true,
   "calendar_visible": true,
   "files_visible": true,
   "database_visible": true,
   "photos_visible": true,
   "wiki_visible": true,
   "member_directory_visible": true,
   "hashtags_visible": true,
   "guidelines_visible": true,
   "subgroups_visible": true,
   "open_donations_visible": true,
   "sponsor_visible": true,
   "manage_subgroups": true,
   "delete_group": true,
   "download_archives": true,
   "download_entire_group": true,
   "download_members": true,
   "view_activity": true,
   "create_hashtags": true,
   "manage_hashtags": true,
   "manage_integrations": true,
   "manage_group_settings": true,
   "make_moderator": true,
   "manage_member_subscription_options": true,
   "manage_pending_members": true,
   "remove_members": true,
   "ban_members": true,
   "manage_group_billing": true,
   "manage_group_payments": true,
   "edit_archives": true,
   "manage_pending_messages": true,
   "invite_members": true,
   "can_post": true,
   "can_vote": true,
   "manage_polls": true,
   "manage_photos": true,
   "manage_members": true,
   "manage_calendar": true,
   "manage_chats": true,
   "view_member_directory": true,
   "manage_files": true,
   "manage_wiki": true,
   "manage_subscription": true,
   "public_page": true,
   "sub_page": true,
   "mod_page": true
}
View Perms definition

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
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 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 desc.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "groupalias",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "name": "example",
    "alias_group_id": 33,
   }
 ],
}
View Group Alias List definition

Example Error Response

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

Add New Group Alias

Add a new group alias.

Permissions Needed

You must have the manage_group_settings permission to use this call. Also, the group having the alias added to must be a premium or enterprise group.

POST Parameters
group_id
required
number

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.
alias_name
required
string

Name of the alias to create.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 alias_name" is returned if the alias name is not a valid group name.
bad_request

"basic group" is returned if the group is not a premium or enterprise group.
Notes

POST /api/v1/newgroupalias

$ curl "https://groups.io/api/v1/newgroupalias" \
-b "cookies.curl" \
-d group_id=65 \
-d alias_name=newalias \
-d csrf=12345

Example Successful Response

 {
   "id": 73387781,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "actually4",
   "nice_group_name": "",
   "alias": "",
   "desc": "This is a test group",
   "plain_desc": "This is a test group",
   "subject_tag": "[actually4]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "allow_non_subs_to_post": false,
   "force_html_emails": false,
   "normalize_html_emails": false,
   "reply_to": "group_reply_to_group",
   "remove_other_reply_options": false,
   "privacy": "group_privacy_none",
   "seperate_footers": false,
   "allow_downloads": "allow_downloads_no",
   "members_visible": "group_view_members_moderators",
   "sub_group_access": "sub_group_subs",
   "calendar_access": "group_access_subscribers",
   "files_access": "group_access_subscribers",
   "database_access": "group_access_subscribers",
   "wiki_access": "group_access_subscribers",
   "photos_access": "group_access_subscribers",
   "member_directory_access": "group_access_subscribers",
   "polls_access": "polls_access_subscribers",
   "chat_access": "group_access_subscribers",
   "handle_attachments": "group_attachments_normal",
   "plain_text_only": false,
   "handle_virus": "handle_virus_block",
   "locked": false,
   "plan": "group_plan_premium",
   "trial_group": false,
   "has_cover_photo": false,
   "has_icon": false,
   "parent_group_id": 0,
   "org_id": 1,
   "max_photo_size_email": "max_photo_size_none",
   "max_photo_size_photos": "max_photo_size_none",
   "max_photo_size_databases": "max_photo_size_none",
   "max_photo_size_wiki_images": "max_photo_size_none",
   "hash_tags_required": false,
   "hash_tag_permissions": "hash_tag_create_subs",
   "bounce_attachments": false,
   "allow_photos_in_files": false,
   "allow_reposts": false,
   "min_days_between_reposts": 0,
   "max_number_of_reposts": 0,
   "email_delivery_default": "email_delivery_single",
   "message_selection_default": "message_selection_all",
   "auto_follow_replies_default": false,
   "max_attachment_size_default": "max_attachment_size_small",
   "default_color": "color_cerulean_blue",
   "default_timezone": "America/Los_Angeles",
   "default_time_pref": "standard_time",
   "default_date_pref": "us_date",
   "default_monday_start": false,
   "disable_edits": false,
   "disable_no_email": false,
   "auto_close_threads": false,
   "close_threads_after": 0,
   "auto_moderate_threads": false,
   "moderate_threads_after": 0,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 361,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "1969-12-31T16: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_weekly_friday",
   "send_invites_on_join": false,
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "email_address": "actually4@groups.io",
   "extra_member_data_columns": [
     {
       "id": 184312747,
       "name": "Collection dream week that be.",
       "type": "text",
       "required": true,
       "color": "color_mulbery",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "So which archipelago wicked along width whom exaltation himself how."
     },
     {
       "id": 130018632,
       "name": "These execute toast whose have.",
       "type": "paragraph",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Why themselves the huge been we something honesty sing as."
     },
     {
       "id": 158522530,
       "name": "Whom whose heap been regularly.",
       "type": "checkbox",
       "required": true,
       "color": "color_lilac",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Build in this how today nearly carrot are near right."
     },
     {
       "id": 77272575,
       "name": "Onion of how product write.",
       "type": "multiple_choice",
       "required": true,
       "color": "color_cloudy_blue",
       "choices": [
         "Covey range window silence lastly had.",
         "What outcome let while school pause.",
         "Up anxiously today whom itself sleep."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Point week doctor movement whose also it vanish watch these."
     },
     {
       "id": 199150300,
       "name": "Quarterly outfit faithful is often.",
       "type": "date",
       "required": true,
       "color": "color_green_lantern",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Part whom these been hourly then smell then under lastly."
     },
     {
       "id": 139937550,
       "name": "Besides pack when murder her.",
       "type": "time",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Had snore first in limp through first open towards besides."
     },
     {
       "id": 35163253,
       "name": "Black monthly ball upon almost.",
       "type": "address",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
     },
     {
       "id": 22148015,
       "name": "Orchard what far upon which.",
       "type": "multi_choice",
       "required": true,
       "color": "color_orange",
       "choices": [
         "Cheese at kiss rarely each her.",
         "Ski ours host our as did.",
         "They to money such this as."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "These bale nobody few how anyone these string life that."
     },
     {
       "id": 23015426,
       "name": "Regularly nearby twist how time.",
       "type": "link",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Yourselves hungry those right empty none another what full her."
     },
     {
       "id": 166687029,
       "name": "Mob nose his me much.",
       "type": "image",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Bathe whoever afterwards myself mine to his how woman no."
     },
     {
       "id": 172741244,
       "name": "Half am yesterday must why.",
       "type": "html_paragraph",
       "required": true,
       "color": "color_none",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
     }
   ]
}
View Group definition

Example Error Response

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

Delete Group Alias

Delete a group alias.

Permissions Needed

You must have the manage_group_settings permission to use this call.

POST Parameters
alias_group_id
required
numer

ID of the alias group object to delete. Either alias_group_id or alias_group_name must be specified.
alias_group_name
required
string

Name of the alias group object to delete. Either alias_group_id or alias_group_name must be specified.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns the aliased group object if the alias is successfully deleted. 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 alias_group_name" is returned if the alias name is not a valid alias.
Notes

POST /api/v1/deletegroupalias

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

Example Successful Response

 {
   "id": 73387781,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "actually4",
   "nice_group_name": "",
   "alias": "",
   "desc": "This is a test group",
   "plain_desc": "This is a test group",
   "subject_tag": "[actually4]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "allow_non_subs_to_post": false,
   "force_html_emails": false,
   "normalize_html_emails": false,
   "reply_to": "group_reply_to_group",
   "remove_other_reply_options": false,
   "privacy": "group_privacy_none",
   "seperate_footers": false,
   "allow_downloads": "allow_downloads_no",
   "members_visible": "group_view_members_moderators",
   "sub_group_access": "sub_group_subs",
   "calendar_access": "group_access_subscribers",
   "files_access": "group_access_subscribers",
   "database_access": "group_access_subscribers",
   "wiki_access": "group_access_subscribers",
   "photos_access": "group_access_subscribers",
   "member_directory_access": "group_access_subscribers",
   "polls_access": "polls_access_subscribers",
   "chat_access": "group_access_subscribers",
   "handle_attachments": "group_attachments_normal",
   "plain_text_only": false,
   "handle_virus": "handle_virus_block",
   "locked": false,
   "plan": "group_plan_premium",
   "trial_group": false,
   "has_cover_photo": false,
   "has_icon": false,
   "parent_group_id": 0,
   "org_id": 1,
   "max_photo_size_email": "max_photo_size_none",
   "max_photo_size_photos": "max_photo_size_none",
   "max_photo_size_databases": "max_photo_size_none",
   "max_photo_size_wiki_images": "max_photo_size_none",
   "hash_tags_required": false,
   "hash_tag_permissions": "hash_tag_create_subs",
   "bounce_attachments": false,
   "allow_photos_in_files": false,
   "allow_reposts": false,
   "min_days_between_reposts": 0,
   "max_number_of_reposts": 0,
   "email_delivery_default": "email_delivery_single",
   "message_selection_default": "message_selection_all",
   "auto_follow_replies_default": false,
   "max_attachment_size_default": "max_attachment_size_small",
   "default_color": "color_cerulean_blue",
   "default_timezone": "America/Los_Angeles",
   "default_time_pref": "standard_time",
   "default_date_pref": "us_date",
   "default_monday_start": false,
   "disable_edits": false,
   "disable_no_email": false,
   "auto_close_threads": false,
   "close_threads_after": 0,
   "auto_moderate_threads": false,
   "moderate_threads_after": 0,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 361,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "1969-12-31T16: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_weekly_friday",
   "send_invites_on_join": false,
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "email_address": "actually4@groups.io",
   "extra_member_data_columns": [
     {
       "id": 184312747,
       "name": "Collection dream week that be.",
       "type": "text",
       "required": true,
       "color": "color_mulbery",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "So which archipelago wicked along width whom exaltation himself how."
     },
     {
       "id": 130018632,
       "name": "These execute toast whose have.",
       "type": "paragraph",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Why themselves the huge been we something honesty sing as."
     },
     {
       "id": 158522530,
       "name": "Whom whose heap been regularly.",
       "type": "checkbox",
       "required": true,
       "color": "color_lilac",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Build in this how today nearly carrot are near right."
     },
     {
       "id": 77272575,
       "name": "Onion of how product write.",
       "type": "multiple_choice",
       "required": true,
       "color": "color_cloudy_blue",
       "choices": [
         "Covey range window silence lastly had.",
         "What outcome let while school pause.",
         "Up anxiously today whom itself sleep."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Point week doctor movement whose also it vanish watch these."
     },
     {
       "id": 199150300,
       "name": "Quarterly outfit faithful is often.",
       "type": "date",
       "required": true,
       "color": "color_green_lantern",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Part whom these been hourly then smell then under lastly."
     },
     {
       "id": 139937550,
       "name": "Besides pack when murder her.",
       "type": "time",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Had snore first in limp through first open towards besides."
     },
     {
       "id": 35163253,
       "name": "Black monthly ball upon almost.",
       "type": "address",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
     },
     {
       "id": 22148015,
       "name": "Orchard what far upon which.",
       "type": "multi_choice",
       "required": true,
       "color": "color_orange",
       "choices": [
         "Cheese at kiss rarely each her.",
         "Ski ours host our as did.",
         "They to money such this as."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "These bale nobody few how anyone these string life that."
     },
     {
       "id": 23015426,
       "name": "Regularly nearby twist how time.",
       "type": "link",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Yourselves hungry those right empty none another what full her."
     },
     {
       "id": 166687029,
       "name": "Mob nose his me much.",
       "type": "image",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Bathe whoever afterwards myself mine to his how woman no."
     },
     {
       "id": 172741244,
       "name": "Half am yesterday must why.",
       "type": "html_paragraph",
       "required": true,
       "color": "color_none",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
     }
   ]
}
View Group definition

Example Error Response

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

Hashtags

New Hashtag

Create a new hashtag.

Permissions Needed

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

POST Parameters
group_id
required
number

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 the hashtag, should begin with #.
description
optional
string

Description of the hashtag.
no_email
optional
boolean

If true, messages with this tag will not be emailed to the group.
reply_to
required
string

How replies to these messages are handled. Can be one of: thread_reply_group_default, thread_reply_to_group, thread_reply_to_sender, thread_reply_to_moderators, thread_reply_to_group_and_sender, thread_reply_only_to_sender
until
required
string

When set, tagged topics will automatically be deleted or locked after the specified time period. Can be one of: hashtag_delete_forever, hashtag_delete_hour, hashtag_delete_day, hashtag_delete_week, hashtag_delete_month, hashtag_delete_three_months, hashtag_delete_six_months, hashtag_delete_year
color
required
string

Color of the tag. Can be one of:
mods_only_post
optional
boolean

If true, only moderators can tag topics with this hashtag.
mods_only_replies
optional
boolean

If true, only moderators can reply to topics tagged with this hashtag.
close_instead
optional
boolean

If true, topics will be locked instead of deleted after the specified time period.
moderated
optional
boolean

If true, messages with this hashtag will be moderated.
locked
optional
boolean

If true, topics created with this hashtag will be locked immediately.
alias
optional
string

If specified, this hashtag is an alias of the named hashtag.
replies_unmoderated
optional
boolean

In moderated groups, if this is true replies to these messages are not moderated.
special
optional
boolean

If true, messages with this tag will be sent as special notices.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 name" is returned if the name is missing or invalid.
"bad_request"

"name exists" is returned if a hashtag with that name already exists.
"bad_request"

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

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

"invalid color" is returned if the color is missing or invalid.

POST /api/v1/newhashtag

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

Example Successful Response

 {
   "id": 1758,
   "object": "hashtag",
   "created": "2020-09-16T20:58:00-07:00",
   "group_id": 903,
   "name": "Barney Parisian",
   "mods_only_post": true,
   "mods_only_replies": false,
   "no_email": true,
   "moderated": true,
   "special": true,
   "replies_unmoderated": false,
   "locked": true,
   "until": "hashtag_delete_month",
   "close_instead_of_delete": false,
   "description": "Them will addition yearly since in these entirely itself.",
   "color_name": "bluejean",
   "color_hex": "#8ec2ee",
   "reply_to": "thread_reply_to_sender",
   "topic_count": 1162,
   "last_message_date": "2020-09-28T03:08:00-07:00",
   "muted": null,
   "followed": null
}
View Hashtag definition

Example Error Response

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

Update Hashtag

Update an existing hashtag.

Permissions Needed

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

POST Parameters
group_id
required
number

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 the hashtag, should begin with #.
new_name
optional
string

New name of the hashtag, should begin with #.
description
optional
string

Description of the hashtag.
no_email
optional
boolean

If true, messages with this tag will not be emailed to the group.
reply_to
optional
string

How replies to these messages are handled. Can be one of: thread_reply_group_default, thread_reply_to_group, thread_reply_to_sender, thread_reply_to_moderators, thread_reply_to_group_and_sender, thread_reply_only_to_sender
until
optional
string

When set, tagged topics will automatically be deleted or locked after the specified time period. Can be one of: hashtag_delete_forever, hashtag_delete_hour, hashtag_delete_day, hashtag_delete_week, hashtag_delete_month, hashtag_delete_three_months, hashtag_delete_six_months, hashtag_delete_year
color
optional
string

Color of the tag. Can be one of:
mods_only_post
optional
boolean

If true, only moderators can tag topics with this hashtag.
mods_only_replies
optional
boolean

If true, only moderators can reply to topics tagged with this hashtag.
close_instead
optional
boolean

If true, topics will be locked instead of deleted after the specified time period.
moderated
optional
boolean

If true, messages with this hashtag will be moderated.
locked
optional
boolean

If true, topics created with this hashtag will be locked immediately.
alias
optional
string

If specified, this hashtag is an alias of the named hashtag.
replies_unmoderated
optional
boolean

In moderated groups, if this is true replies to these messages are not moderated.
special
optional
boolean

If true, messages with this tag will be sent as special notices.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 name" is returned if the name is missing or invalid.
"bad_request"

"name exists" is returned if a hashtag with that name already exists.
"bad_request"

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

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

"invalid color" is returned if the color is missing or invalid.

POST /api/v1/updatehashtag

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

Example Successful Response

 {
   "id": 1758,
   "object": "hashtag",
   "created": "2020-09-16T20:58:00-07:00",
   "group_id": 903,
   "name": "Barney Parisian",
   "mods_only_post": true,
   "mods_only_replies": false,
   "no_email": true,
   "moderated": true,
   "special": true,
   "replies_unmoderated": false,
   "locked": true,
   "until": "hashtag_delete_month",
   "close_instead_of_delete": false,
   "description": "Them will addition yearly since in these entirely itself.",
   "color_name": "bluejean",
   "color_hex": "#8ec2ee",
   "reply_to": "thread_reply_to_sender",
   "topic_count": 1162,
   "last_message_date": "2020-09-28T03:08:00-07:00",
   "muted": null,
   "followed": null
}
View Hashtag definition

Example Error Response

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

Get Hashtags

Get hashtags

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   }
 ],
}
View Hashtag List definition

Example Error Response

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

Delete Hashtag

Delete a hashtag.

Permissions Needed

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

POST Parameters
group_id
required
number

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 the hashtag, should begin with #.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 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.

POST /api/v1/deletehashtag

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

Successful Response

HTTP 200

Example Error Response

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

Mute Hashtag

Mute a hashtag.

Permissions Needed

You must be subscribed to the group.

POST Parameters
hashtag
required
string

Hashtag to mute.
group_id
required
number

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.
until
required
string

How long to mute the hashtag for, can be mute_hour, mute_day, mute_week, mute_month, mute_forever.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 until" is returned if the until value is invalid.

POST /api/v1/mutehashtag

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

Successful Response

HTTP 200

Example Error Response

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

Unmute Hashtag

Unmute a hashtag.

Permissions Needed

You must be subscribed to the group.

POST Parameters
hashtag
required
string

Hashtag to unmute.
group_id
required
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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"

"not muting hashtag" is returned if you are not currently muting this hashtag.

POST /api/v1/unmutehashtag

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

Successful Response

HTTP 200

Example Error Response

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

Follow Hashtag

Follow a hashtag.

Permissions Needed

You must be subscribed to the group.

POST Parameters
hashtag
required
string

Hashtag to follow.
group_id
required
number

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.
until
required
string

How long to follow the hashtag for, can be mute_hour, mute_day, mute_week, mute_month, mute_forever.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 until" is returned if the until value is invalid.

POST /api/v1/followhashtag

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

Successful Response

HTTP 200

Example Error Response

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

Unfollow Hashtag

Unfollow a hashtag.

Permissions Needed

You must be subscribed to the group.

POST Parameters
hashtag
required
string

Hashtag to unfollow.
group_id
required
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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"

"not following hashtag" is returned if you are not currently following this hashtag.

POST /api/v1/unfollowhashtag

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

Successful Response

HTTP 200

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.
token
optional
boolena

If true, use token based login instead of cookie based login. With token based logins, some features of the API are not available, like chat.
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"

Example Successful Response

 {
 "user": 
   {
      "id": 147779411,
      "object": "user",
      "created": "2020-09-01T08:47:00-07:00",
      "updated": "2022-03-01T17:18:00-08:00",
      "email": "gersonbeahan@jacobi.io",
      "full_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "status": "user_status_confirmed",
      "profile_photo_url": "",
      "post_pref": "user_postpref_html",
      "per_page_pref": "user_per_page_pref20",
      "allow_facebook_login": false,
      "allow_google_login": false,
      "allow_sso_login": false,
      "csrf_token": "84491575",
      "two_factor_enabled": false,
      "recovery_codes": "",
      "dont_munge_message_id": false,
      "about_me": "Today awfully arrive at",
      "about_format": "about_html",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "time_pref": "standard_time",
      "date_pref": "us_date",
      "monday_start": false,
      "profile_privacy": "profile_private",
      "default_message_view": "thread_view",
      "topics_sort_dir": "sort_none",
      "topic_sort_dir": "sort_none",
      "messages_sort_dir": "sort_none",
      "expanded_messages_sort_dir": "sort_none",
      "search_sort": "relevance_sort",
      "search_sort_dir": "sort_none",
      "photos_order_by": "",
      "photos_sort_dir": "sort_none",
      "album_order_by": "",
      "album_sort_dir": "sort_none",
      "default_calendar_view": "cal_view_month",
      "default_hashtag_view": "view_grid",
      "default_rsvp_view": "view_grid",
      "home_page": "home_page_feed"
   },
 "token": "aabbffed2213234",
}
View Login definition

Example Error Response

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

Get Enterprise Info

Return information about an enterprise group.

Query Parameters
domain
required
string

Domain of the enterprise group.
Returns

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

Additional Errors
"bad_request"

"invalid domain" is returned if the domain is missing or invalid.

GET /api/v1/enterpriseinfo

$ curl "https://groups.io/api/v1/getenterpriseinfo?domain=groups.example.com"

Successful Response

HTTP 200

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

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

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

 {
 "user": 
   {
      "id": 147779411,
      "object": "user",
      "created": "2020-09-01T08:47:00-07:00",
      "updated": "2022-03-01T17:18:00-08:00",
      "email": "gersonbeahan@jacobi.io",
      "full_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "status": "user_status_confirmed",
      "profile_photo_url": "",
      "post_pref": "user_postpref_html",
      "per_page_pref": "user_per_page_pref20",
      "allow_facebook_login": false,
      "allow_google_login": false,
      "allow_sso_login": false,
      "csrf_token": "84491575",
      "two_factor_enabled": false,
      "recovery_codes": "",
      "dont_munge_message_id": false,
      "about_me": "Today awfully arrive at",
      "about_format": "about_html",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "time_pref": "standard_time",
      "date_pref": "us_date",
      "monday_start": false,
      "profile_privacy": "profile_private",
      "default_message_view": "thread_view",
      "topics_sort_dir": "sort_none",
      "topic_sort_dir": "sort_none",
      "messages_sort_dir": "sort_none",
      "expanded_messages_sort_dir": "sort_none",
      "search_sort": "relevance_sort",
      "search_sort_dir": "sort_none",
      "photos_order_by": "",
      "photos_sort_dir": "sort_none",
      "album_order_by": "",
      "album_sort_dir": "sort_none",
      "default_calendar_view": "cal_view_month",
      "default_hashtag_view": "view_grid",
      "default_rsvp_view": "view_grid",
      "home_page": "home_page_feed"
   },
 "token": "aabbffed2213234",
}
View Login definition

Example Error Response

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

Apple Login Start

Start the Apple login process.

Returns

Returns an oauth login object. Returns an error otherwise.

GET /api/v1/appleloginstart

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

Example Successful Response

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

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

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

Example Error Response

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

Apple Login Final

Complete the Apple login process. If the email address returned by Apple 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. THIS IS CURRENTLY DISABLED.

POST Parameters
state
required
string

Returned from Apple.
code
required
string

Returned from Apple. 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 Apple. 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 Apple logins.
"bad_request"

"invalid email address" is returned if the email address returned by Facebook is empty or invalid.
"bad_request"

"apple login prevented" is returned if the user has disabled Apple logins. When this error is returned, an email is sent to the user with a link to enable Apple logins.

POST /api/v1/appleloginfinal

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

Example Successful Response

 {
 "user": 
   {
      "id": 147779411,
      "object": "user",
      "created": "2020-09-01T08:47:00-07:00",
      "updated": "2022-03-01T17:18:00-08:00",
      "email": "gersonbeahan@jacobi.io",
      "full_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "status": "user_status_confirmed",
      "profile_photo_url": "",
      "post_pref": "user_postpref_html",
      "per_page_pref": "user_per_page_pref20",
      "allow_facebook_login": false,
      "allow_google_login": false,
      "allow_sso_login": false,
      "csrf_token": "84491575",
      "two_factor_enabled": false,
      "recovery_codes": "",
      "dont_munge_message_id": false,
      "about_me": "Today awfully arrive at",
      "about_format": "about_html",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "time_pref": "standard_time",
      "date_pref": "us_date",
      "monday_start": false,
      "profile_privacy": "profile_private",
      "default_message_view": "thread_view",
      "topics_sort_dir": "sort_none",
      "topic_sort_dir": "sort_none",
      "messages_sort_dir": "sort_none",
      "expanded_messages_sort_dir": "sort_none",
      "search_sort": "relevance_sort",
      "search_sort_dir": "sort_none",
      "photos_order_by": "",
      "photos_sort_dir": "sort_none",
      "album_order_by": "",
      "album_sort_dir": "sort_none",
      "default_calendar_view": "cal_view_month",
      "default_hashtag_view": "view_grid",
      "default_rsvp_view": "view_grid",
      "home_page": "home_page_feed"
   },
 "token": "aabbffed2213234",
}
View Login definition

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

 {
 "user": 
   {
      "id": 147779411,
      "object": "user",
      "created": "2020-09-01T08:47:00-07:00",
      "updated": "2022-03-01T17:18:00-08:00",
      "email": "gersonbeahan@jacobi.io",
      "full_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "status": "user_status_confirmed",
      "profile_photo_url": "",
      "post_pref": "user_postpref_html",
      "per_page_pref": "user_per_page_pref20",
      "allow_facebook_login": false,
      "allow_google_login": false,
      "allow_sso_login": false,
      "csrf_token": "84491575",
      "two_factor_enabled": false,
      "recovery_codes": "",
      "dont_munge_message_id": false,
      "about_me": "Today awfully arrive at",
      "about_format": "about_html",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "time_pref": "standard_time",
      "date_pref": "us_date",
      "monday_start": false,
      "profile_privacy": "profile_private",
      "default_message_view": "thread_view",
      "topics_sort_dir": "sort_none",
      "topic_sort_dir": "sort_none",
      "messages_sort_dir": "sort_none",
      "expanded_messages_sort_dir": "sort_none",
      "search_sort": "relevance_sort",
      "search_sort_dir": "sort_none",
      "photos_order_by": "",
      "photos_sort_dir": "sort_none",
      "album_order_by": "",
      "album_sort_dir": "sort_none",
      "default_calendar_view": "cal_view_month",
      "default_hashtag_view": "view_grid",
      "default_rsvp_view": "view_grid",
      "home_page": "home_page_feed"
   },
 "token": "aabbffed2213234",
}
View Login definition

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
number

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, can be: member_notice_joining, member_notice_pending, member_notice_leaving, member_notice_banned, member_notice_rejected_sub, member_notice_invite, member_notice_direct_add, member_notice_rejected_message, member_notice_removed_sub, member_notice_post_to_sub, member_notice_guidelines, member_notice_locked_group, member_notice_monthly_reminder
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
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "id": 63,
 "object": "member_notice",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 33,
 "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": "",
}
View Member Notice definition

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
number

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, can be: member_notice_joining, member_notice_pending, member_notice_leaving, member_notice_banned, member_notice_rejected_sub, member_notice_invite, member_notice_direct_add, member_notice_rejected_message, member_notice_removed_sub, member_notice_post_to_sub, member_notice_guidelines, member_notice_locked_group, member_notice_monthly_reminder
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
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "id": 63,
 "object": "member_notice",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 33,
 "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": "",
}
View Member Notice definition

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
number

ID of the member notice to delete.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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
number

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
string

Type of member notice to return, can be: member_notice_joining, member_notice_pending, member_notice_leaving, member_notice_banned, member_notice_rejected_sub, member_notice_invite, member_notice_direct_add, member_notice_rejected_message, member_notice_removed_sub, member_notice_post_to_sub, member_notice_guidelines, member_notice_locked_group, member_notice_monthly_reminder
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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: name, msgtype, updated, created.
sort_dir
optional
string

Sort direction. Can be asc or desc.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "member_notice",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "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": "",
   }
 ],
}
View Member Notice List definition

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
number

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
number

ID of the member info object.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

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
number

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
number

ID of the member info object.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

"trial group" is returned if the group is a trial 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

 {
 "object": "direct_add_results",
 "total_emails": 63,
 "errors": [
   {
    "object": "direct_add_error",
    "email": "",
    "alias_of": "",
    "status": "",
    "group_id": 63,
   }
 ],
 "added_members": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Direct Add Results definition

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 members_visible permission to use this call.

Query Parameters
group_id
required
number

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
number

ID of the member info object
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

Example Error Response

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

Get Member Directory

Get the group member directory. 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_member_directory permission to use this call.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 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.
sort_dir
optional
string

Sort direction. Can be 'asc' or 'desc'.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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"

"private profile" is returned the user's profile is private. Only people without a private profile can view the member directory.
  • No additional errors

GET /api/v1/getmemberdirectory

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Member Info List definition

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 members_visible or view_member_directory permission to use this call.

Query Parameters
group_id
required
number

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
default is members

The type of member to be returned, can be pending, banned, mods, members, bouncing. See Notes for restrictions.
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 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'.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Member Info List definition

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 members_visible permission to use this call. In addition, the group must be a Premium or Enterprise group.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 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'.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "past_member",
    "created": "2009-11-10T15:00:00-08:00",
    "action": "spamleft",
    "member_info": 
      {
         "id": 93518468,
         "object": "member_info",
         "created": "2020-09-05T13:57:00-07:00",
         "updated": "2023-02-12T13:06:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "group_name": "actually4",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_single",
         "message_selection": "message_selection_all",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_unlimited",
         "approved_posts": 0,
         "mod_status": "sub_modstatus_owner",
         "pending_msg_notify": "sub_notify_email_and_app",
         "pending_sub_notify": "sub_notify_email_and_app",
         "sub_notify": "sub_notify_email_and_app",
         "storage_notify": "sub_notify_email_and_app",
         "sub_group_notify": "sub_notify_email_and_app",
         "message_report_notify": "sub_notify_email_and_app",
         "account_notify": "sub_notify_email_and_app",
         "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
         "owner_msg_notify": "sub_ownermsg_notify_subs",
         "chat_notify": "sub_notify_email_and_app",
         "photo_notify": "sub_notify_email_and_app",
         "file_notify": "sub_notify_email_and_app",
         "wiki_notify": "sub_notify_email_and_app",
         "database_notify": "sub_notify_email_and_app",
         "email": "gersonbeahan@jacobi.io",
         "user_status": "user_status_confirmed",
         "user_name": "Dickens6041",
         "timezone": "America/Chicago",
         "full_name": "Lawson Kreiger",
         "about_me": "Today awfully arrive at",
         "location": "Well away onto",
         "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "Growth one album",
         "color": "color_cerulean_blue",
         "cover_photo_url": "",
         "icon_url": "",
         "nice_group_name": "",
         "subs_count": 0,
         "most_recent_message": "0001-01-01T00:00:00Z",
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "extra_member_data": [
           {
             "col_id": 184312747,
             "col_type": "text",
             "text": "Other openly practically why gun it scold far hourly formerly."
           },
           {
             "col_id": 130018632,
             "col_type": "paragraph",
             "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
           },
           {
             "col_id": 158522530,
             "col_type": "checkbox",
             "checked": false
           },
           {
             "col_id": 77272575,
             "col_type": "multiple_choice"
           },
           {
             "col_id": 199150300,
             "col_type": "date",
             "date": "0001-01-01T00:00:00Z"
           },
           {
             "col_id": 139937550,
             "col_type": "time",
             "time": "1919-04-03T21:05:37.017498068Z"
           },
           {
             "col_id": 35163253,
             "col_type": "address",
             "street_address1": "56235 Club ton",
             "street_address2": "772 Port Valleys stad",
             "city": "Chandler",
             "state": "Nebraska",
             "zip": "58231",
             "country": "Gibraltar"
           },
           {
             "col_id": 22148015,
             "col_type": "multi_choice"
           },
           {
             "col_id": 23015426,
             "col_type": "link",
             "title": "Philippine before throughout wander of as there next of sleep.",
             "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
             "desc": "Cap today am terribly many because anyone does you hungrily."
           },
           {
             "col_id": 166687029,
             "col_type": "image",
             "url": "https://picsum.photos/id/83/200/300",
             "image_name": "Eastern with herself muster monthly it party another his ours."
           },
           {
             "col_id": 172741244,
             "col_type": "html_paragraph",
             "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
           }
         ]
      },
   }
 ],
}
View Past Member List definition

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
number

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
number

ID of the member info object.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

Example Error Response

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

Search Member Directory

Search the member directory. The search is over full names and profile information. 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_member_directory permission to use this call.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 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'.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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/searchmemberdirectory

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Member Info List definition

Example Error Response

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

Search Members

Search the members of a group. The search is over email addresses, full names and moderator notes. 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 members_visible permission to use this call.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 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'.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Member Info List definition

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
number

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
number

ID of the member info object.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

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
number

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
number

ID of the member info object.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "direct_add_results",
 "total_emails": 63,
 "errors": [
   {
    "object": "direct_add_error",
    "email": "",
    "alias_of": "",
    "status": "",
    "group_id": 63,
   }
 ],
 "added_members": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Direct Add Results definition

Example Error Response

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

Unban Member

Unban this member.

Permissions Needed

You must have the ban_members permission to use this call.

POST Parameters
group_id
required
number

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
number

ID of the member info object.
csrf
required
string

The csrf_token from the user object returned when first logged in.
Returns

Returns HTTP 200 if the unban 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 not banned" is returned if the member's status is not 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/unbanmember

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

Successful Response

HTTP 200

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
number

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
number

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, sub_poststatus_mod_first_message, sub_poststatus_mod_started_topics
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

Automatically follow any topics you start or reply to.
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

The member's full name.
moderator_notes
optional
string

Notes about the member.
chat_msg_notify
optional
string

Notify when someone posts a message to a chat this person is subscribed to, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
like_notify
optional
string

Notify when someone likes a message this person posted, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
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_managehashtags, 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_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
pending_sub_notify
optional
string

Notify about pending subscriptions, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
sub_notify
optional
string

Notify when someone joins the group, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
storage_notify
optional
string

Notify when storage limits are reached, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
sub_group_notify
optional
string

Notify when a subgroup is created, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
message_report_notify
optional
string

Notify when someone reports a message, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
chat_notify
optional
string

Notify when someone starts a chat, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
photo_notify
optional
string

Notify when someone creates a photo album or uploads a photo, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
file_notify
optional
string

Notify when someone creates a folder or uploads a file, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
wiki_notify
optional
string

Notify when someone creates or modifies a wiki page, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
database_notify
optional
string

Notify when someone creates or modifies a database, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
color
optional
string

Color assigned to the member.
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
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.

The following fields relate to setting extra_member_data fields. Each column, as defined in the extra_member_data_columns array in the Group Object, consists of a Database Column Object, which defines the various aspects of the column.
text_N
optional
string

Response for text and paragraph columns. N is the ID of column.
number_N
optional
number

Response for number columns. N is the ID of column.
editor_N
optional
string

Response for html_paragraph columns. N is the ID of column.
checked_N
optional
boolean

Response for checkbox columns. N is the ID of column.
choice_N
optional
boolean

Response for multiple_choice columns. N is the ID of column.
multichoice_N_M
optional
boolean

Response for multi_choice columns. N is the ID of column. M corresponds to the choices array in the database column object, indexed starting at 1.
date_N
optional
string

Response for date columns. N is the ID of the column.
time_N
optional
string

Response for time columns. N is the ID of the column.
address1_N
optional
string

First address line for address columns. N is the ID of the column.
address2_N
optional
string

Second address line for address columns. N is the ID of the column.
city_N
optional
string

City line for address columns. N is the ID of the column.
state_N
optional
string

State line for address columns. N is the ID of the column.
zip_N
optional
string

Zip line for address columns. N is the ID of the column.
country_N
optional
string

Country line for address columns. N is the ID of the column.
url_N
optional
string

URL for link columns. N is the ID of the column.
title_N
optional
string

Title for link columns. N is the ID of the column.
desc_N
optional
string

Description for link columns. N is the ID of the column.
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"

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

"moderators cannot change role of owners" is returned if a non-owner attempts to change the mod_status field of an owner.
"bad_request"

"moderators cannot make members owners" is returned if a non-owner attempts to make a member an owner.
"bad_request"

"moderators cannot change owner subscription settings" is returned if a non-owner attempts to change an owner's subscription settings.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

Example Error Response

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

Notifications

These API endpoints deal with pushsub notifications.

Add Push Sub

Register a new push sub to receive notifications.

Permissions Needed

None.

POST Parameters
token
required
string

Device ID token.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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/addpushsub

$ curl "https://groups.io/api/v1/addpushsub" \
-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.

Permissions Needed

None.

POST Parameters
csrf
required
string

The csrf_token from the user object returned when first logged in.
token
required
string

Device ID token.
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": ""
 }

Get Push Subs

Get push subs. Push subs are returned using the pagination request and object format.

Permissions Needed

None.

Query Parameters
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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 push sub list object if successful. Returns an error if there is an error.

Additional Errors
No additional errors

GET /api/v1/getpushsubs

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "push_sub",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "type": "mobile_push_sub",
    "os": "",
    "browser": "app",
    "p256dh": "",
    "auth": "",
    "endpoint": "",
   }
 ],
}
View Push Sub List definition

Example Error Response

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

Delete Push Subscription

Delete a single push subscription.

Permissions Needed

None.

POST Parameters
pushsub_id
required
number

ID of the pushsub to delete. You must be the owner of the pushsub.
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 pushsub_id" is returned if the pushsub id is missing or invalid.

POST /api/v1/deletepushsub

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

Successful Response

HTTP 200

Example Error Response

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

Delete All Push Subscriptions

Delete all push subscriptions for a user.

Permissions Needed

None.

POST Parameters
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
None.

POST /api/v1/deleteallpushsubs

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

Successful Response

HTTP 200

Example Error Response

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

Orgs

Orgs represent enterprise groups.

Get Org

Get the org object associated with the domain the API request came in on.

Permissions Needed

You must be an owner of the requested enterprise group.

Query Parameters
None
Returns

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

Additional Errors
No additional errors

GET /api/v1/getorg

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

Example Successful Response

 {
   "id": 1,
   "object": "org",
   "created": "1969-12-31T16:00:00-08:00",
   "updated": "1969-12-31T16:00:00-08:00",
   "title": "Groups.io",
   "domain": "groups.io",
   "parent_group_id": 0,
   "logged_out_wiki_page_id": 0,
   "default_timezone": "",
   "disable_signup": false,
   "disable_plus_one": false,
   "ga_code": "",
   "login_page_text": "",
   "no_account_text": "",
   "sso_provider": "no_sso",
   "sso_client_id": "",
   "sso_client_secret": "",
   "sso_domain": ""
}
View Org definition

Example Error Response

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

Pending Messages

Get Pending Messages

Get pending messages. Pending messages are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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 pending message list object if successful. Returns an error if there is an error.

Additional Errors
No additional errors

GET /api/v1/getpendingmessages

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "pending_message",
    "id": 63,
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "user_id": 47,
    "subject": "",
    "is_special": false,
    "is_web_post": false,
    "has_attachments": false,
    "editor_member_id": 78,
    "raw_message": "",
    "message_body": "",
    "body_format": "",
    "sender": 
      {
         "profile_photo_url": "",
         "name": "Lawson Kreiger",
         "can_view_profile": false
      },
    "sender_email": "",
    "sender_name": "",
    "claiming_user": 
      {
         "profile_photo_url": "",
         "name": "Lawson Kreiger",
         "can_view_profile": false
      },
    "claimed_date": "2009-11-10T15:00:00-08:00",
    "editor": 
      {
         "profile_photo_url": "",
         "name": "Lawson Kreiger",
         "can_view_profile": false
      },
    "edit_reason": "",
    "type": "",
    "virus_name": "",
   }
 ],
}
View Pending Message List definition

Example Error Response

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

Approve Pending Messages

Approve pending message objects. Messages are sent to the group and the pending message objects are deleted.

Permissions Needed

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

POST Parameters
group_id
required
number

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.
pending_message_ids
required
numbers

Comma separated list of IDs of the pending messages to approve.
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 pending_message_ids" is returned if the pending message id is missing or invalid.
"bad_request"

"message claimed" is returned if the pending message has previously been claimed by someone else.

POST /api/v1/approvependingmessages

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

Successful Response

HTTP 200

Example Error Response

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

Claim Pending Message

Claim a pending message object. The pending message will be claimed by the currently logged in user.

Permissions Needed

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

POST Parameters
group_id
required
number

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.
pending_message_id
required
number

ID of the pending message 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.

Additional Errors
"bad_request"

"invalid pending_message_id" is returned if the pending message id is missing or invalid.

POST /api/v1/claimpendingmessage

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

Successful Response

HTTP 200

Example Error Response

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

Delete Pending Messages

Delete pending message objects.

Permissions Needed

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

POST Parameters
group_id
required
number

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.
pending_message_ids
required
numbers

Comma separated list of IDs of the pending messages to delete. All messages must be in the same group.
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 pending_message_ids" is returned if the pending message id is missing or invalid.
"bad_request"

"message claimed" is returned if the pending message has previously been claimed by someone else.

POST /api/v1/deletependingmessages

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

Successful Response

HTTP 200

Example Error Response

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

Reject Pending Messages

Reject pending message objects. A rejection message is sent to the sender of each message and the pending message is deleted.

Permissions Needed

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

POST Parameters
group_id
required
number

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.
pending_message_ids
required
numbers

Comma separated list of IDs of the pending messages to reject.
reason
required
string

The message to send the person who sent each pending message, in plain text.
subject
required
string

The subject line of the message to send the person who sent the pending message, in plain text.
bccall
optional
boolean

If true, email all group moderators a copy of the rejection message.
bccme
optional
boolean

If true, email me a copy of the rejection message.
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 pending_message_ids" is returned if the pending message id is missing or invalid.
"bad_request"

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

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

"message claimed" is returned if the pending message has previously been claimed by someone else.

POST /api/v1/rejectpendingmessages

$ curl "https://groups.io/api/v1/rejectpendingmessage" \
-b "cookies.curl" \
-d pending_message_ids=12&csrf=1234&reason="I'm rejecting this"&subject="Rejection message"&group_id=12

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 131773379,
   "object": "album",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "upload_perms": "album_upload_group",
   "title": "Example will addition yearly since",
   "desc": "In these entirely itself whose rather.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 19
}
View Album definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 131773379,
   "object": "album",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "upload_perms": "album_upload_group",
   "title": "Example will addition yearly since",
   "desc": "In these entirely itself whose rather.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 19
}
View Album definition

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 photos_visible permission to use this call with a group.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "album",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "upload_perms": "album_upload_group",
       "title": "Example will addition",
       "desc": "Yearly since in these entirely.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 18
     },
     {
       "id": 134081794,
       "object": "album",
       "created": "2020-09-26T00:35:00-07:00",
       "updated": "2023-02-05T22:45:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "upload_perms": "album_upload_group",
       "title": "Sleep over tea contrast",
       "desc": "Line to say poorly out according abundant unless.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 11
     },
     {
       "id": 120104241,
       "object": "album",
       "created": "2020-09-02T16:26:00-07:00",
       "updated": "2022-01-24T16:02:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "upload_perms": "album_upload_group",
       "title": "Say lastly advertising faithfully it",
       "desc": "Later depend deeply everybody rhythm for had does soften.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 27
     }
   ]
}
View Album List definition

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
number

ID of the album.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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
number

ID of the photo album to add the photo to.
fileupload
required
multipart file

Multipart file upload of one or more photos.
description
optional
string

A description to be added to the photos.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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.
"bad_request"

"no space" is returned if the group is out of storage space.
"bad_request"

"too big" is returned if the photo is too large.

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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 207,
       "object": "photo",
       "created": "2020-09-07T04:11:00-07:00",
       "updated": "2022-01-31T13:36:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Itself whose rather theirs additionally line",
       "desc": "To say poorly out according abundant.",
       "media_type": "image/jpg",
       "size": 887202,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 131773379,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1729,
       "object": "photo",
       "created": "2020-09-20T08:33:00-07:00",
       "updated": "2021-10-28T06:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Soften anyone anyway then to with",
       "desc": "Wild hourly there she it infrequently power tonight.",
       "media_type": "image/jpg",
       "size": 5553891,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 191492111,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 400,
       "object": "photo",
       "created": "2020-09-01T00:15:00-07:00",
       "updated": "2022-02-26T15:50:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Mine this yesterday",
       "desc": "I smell us courageous some.",
       "media_type": "image/jpg",
       "size": 9963632,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 27198439,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}
View Photo List definition

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
number

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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.
"bad_request"

"no space" is returned if the group is out of space.

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

 {
   "id": 131773379,
   "object": "album",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "upload_perms": "album_upload_group",
   "title": "Example will addition yearly since",
   "desc": "In these entirely itself whose rather.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 19
}
View Album definition

Example Error Response

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

Get Photo

Get photo.

Permissions Needed

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

Query Parameters
group_id
required
number

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
number

ID of the album that contains the photo, or 0 if viewing a photo sent as a message attachment.
photo_id
required
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 893,
   "object": "photo",
   "created": "2020-09-07T18:08:00-07:00",
   "updated": "2022-09-25T00:35:00-07:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "name": "Theirs additionally line",
   "desc": "To say poorly out according.",
   "media_type": "image/jpg",
   "size": 4060156,
   "attachment_num": 0,
   "width": 0,
   "height": 0,
   "album_id": 131773379,
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "format": "jpeg",
   "focal_length": 0,
   "iso": 0,
   "aperture": 0,
   "shutter_speed": 0,
   "taken": 0,
   "make": "",
   "model": ""
}
View Photo definition

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 photos_visible permission to use this call with a group.

Query Parameters
group_id
required
number

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
number

ID of the photo album to view.
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 207,
       "object": "photo",
       "created": "2020-09-07T04:11:00-07:00",
       "updated": "2022-01-31T13:36:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Itself whose rather theirs additionally line",
       "desc": "To say poorly out according abundant.",
       "media_type": "image/jpg",
       "size": 887202,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 131773379,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1729,
       "object": "photo",
       "created": "2020-09-20T08:33:00-07:00",
       "updated": "2021-10-28T06:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Soften anyone anyway then to with",
       "desc": "Wild hourly there she it infrequently power tonight.",
       "media_type": "image/jpg",
       "size": 5553891,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 191492111,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 400,
       "object": "photo",
       "created": "2020-09-01T00:15:00-07:00",
       "updated": "2022-02-26T15:50:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Mine this yesterday",
       "desc": "I smell us courageous some.",
       "media_type": "image/jpg",
       "size": 9963632,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 27198439,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}
View Photo List definition

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 photos_visible permission to use this call with a group.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 207,
       "object": "photo",
       "created": "2020-09-07T04:11:00-07:00",
       "updated": "2022-01-31T13:36:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Itself whose rather theirs additionally line",
       "desc": "To say poorly out according abundant.",
       "media_type": "image/jpg",
       "size": 887202,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 131773379,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1729,
       "object": "photo",
       "created": "2020-09-20T08:33:00-07:00",
       "updated": "2021-10-28T06:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Soften anyone anyway then to with",
       "desc": "Wild hourly there she it infrequently power tonight.",
       "media_type": "image/jpg",
       "size": 5553891,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 191492111,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 400,
       "object": "photo",
       "created": "2020-09-01T00:15:00-07:00",
       "updated": "2022-02-26T15:50:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Mine this yesterday",
       "desc": "I smell us courageous some.",
       "media_type": "image/jpg",
       "size": 9963632,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 27198439,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}
View Photo List definition

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
number

ID of the photo.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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
number

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
multiple, string

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "id": 63,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "can_view_results": false,
 "answers": [
   {
    "answer": "",
    "selected": false,
   }
 ],
 "results": [
   {
    "answer": "",
    "count": 63,
    "percentage": "",
    "votes": [
      {
       "user_id": 63,
       "email": "",
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
      }
    ],
   }
 ],
 "is_closed": false,
 "msg_num": 33,
 "anonymous": false,
}
View Poll definition

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
number

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
multiple, string

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "id": 63,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "can_view_results": false,
 "answers": [
   {
    "answer": "",
    "selected": false,
   }
 ],
 "results": [
   {
    "answer": "",
    "count": 63,
    "percentage": "",
    "votes": [
      {
       "user_id": 63,
       "email": "",
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
      }
    ],
   }
 ],
 "is_closed": false,
 "msg_num": 33,
 "anonymous": false,
}
View Poll definition

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
number

ID of the poll to update.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "id": 63,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "can_view_results": false,
 "answers": [
   {
    "answer": "",
    "selected": false,
   }
 ],
 "results": [
   {
    "answer": "",
    "count": 63,
    "percentage": "",
    "votes": [
      {
       "user_id": 63,
       "email": "",
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
      }
    ],
   }
 ],
 "is_closed": false,
 "msg_num": 33,
 "anonymous": false,
}
View Poll definition

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
number

ID of the poll.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 poll_id=12

Example Successful Response

 {
 "poll_id": 63,
 "object": "poll_results",
 "results": [
   {
    "answer": "",
    "count": 63,
    "percentage": "",
    "votes": [
      {
       "user_id": 63,
       "email": "",
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
      }
    ],
   }
 ],
}
View Poll Results definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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": ""
 }

Sub Group Categories

Get Sub Group Categories

Get sub group categories. Categories are returned using the pagination request and object format.

Permissions Needed

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

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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 "name" and "order".
sort_dir
optional
string

Sort direction. Can be asc or desc.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a Sub Group Catgeory list object if successful. Returns an error if there is an error.

Additional Errors
No additional errors

GET /api/v1/getsubgroupcategories

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

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "sub_group_category",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "parent_group_id": 33,
    "name": "example",
    "desc": "",
    "max_subs": 47,
    "order": 78,
   }
 ],
}
View Sub Group Category List definition

Example Error Response

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

Get Sub Groups By Category

Get sub groups by category.

Permissions Needed

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

Query Parameters
group_id
required
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a Sub Groups By Catgeory object if successful. Returns an error if there is an error.

Additional Errors
No additional errors

GET /api/v1/getsubgroupsbycategory

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

Example Successful Response

 {
 "subscribed": [
   {
    "category": 
      {
       "id": 63,
       "object": "sub_group_category",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "parent_group_id": 33,
       "name": "example",
       "desc": "",
       "max_subs": 47,
       "order": 78,
      },
    "group": 
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      },
   }
 ],
 "uncategorized": [
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   }
 ],
 "by_category": [
   {
    "category": 
      {
       "id": 63,
       "object": "sub_group_category",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "parent_group_id": 33,
       "name": "example",
       "desc": "",
       "max_subs": 47,
       "order": 78,
      },
    "group": 
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      },
   }
 ],
}
View Sub Groups By Category definition

Example Error Response

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

User

Register User

Register a new 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

 {
 "user": 
   {
      "id": 147779411,
      "object": "user",
      "created": "2020-09-01T08:47:00-07:00",
      "updated": "2022-03-01T17:18:00-08:00",
      "email": "gersonbeahan@jacobi.io",
      "full_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "status": "user_status_confirmed",
      "profile_photo_url": "",
      "post_pref": "user_postpref_html",
      "per_page_pref": "user_per_page_pref20",
      "allow_facebook_login": false,
      "allow_google_login": false,
      "allow_sso_login": false,
      "csrf_token": "84491575",
      "two_factor_enabled": false,
      "recovery_codes": "",
      "dont_munge_message_id": false,
      "about_me": "Today awfully arrive at",
      "about_format": "about_html",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "time_pref": "standard_time",
      "date_pref": "us_date",
      "monday_start": false,
      "profile_privacy": "profile_private",
      "default_message_view": "thread_view",
      "topics_sort_dir": "sort_none",
      "topic_sort_dir": "sort_none",
      "messages_sort_dir": "sort_none",
      "expanded_messages_sort_dir": "sort_none",
      "search_sort": "relevance_sort",
      "search_sort_dir": "sort_none",
      "photos_order_by": "",
      "photos_sort_dir": "sort_none",
      "album_order_by": "",
      "album_sort_dir": "sort_none",
      "default_calendar_view": "cal_view_month",
      "default_hashtag_view": "view_grid",
      "default_rsvp_view": "view_grid",
      "home_page": "home_page_feed"
   },
 "token": "aabbffed2213234",
}
View Login definition

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

 {
   "id": 147779411,
   "object": "user",
   "created": "2020-09-01T08:47:00-07:00",
   "updated": "2022-03-01T17:18:00-08:00",
   "email": "gersonbeahan@jacobi.io",
   "full_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "status": "user_status_confirmed",
   "profile_photo_url": "",
   "post_pref": "user_postpref_html",
   "per_page_pref": "user_per_page_pref20",
   "allow_facebook_login": false,
   "allow_google_login": false,
   "allow_sso_login": false,
   "csrf_token": "84491575",
   "two_factor_enabled": false,
   "recovery_codes": "",
   "dont_munge_message_id": false,
   "about_me": "Today awfully arrive at",
   "about_format": "about_html",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "time_pref": "standard_time",
   "date_pref": "us_date",
   "monday_start": false,
   "profile_privacy": "profile_private",
   "default_message_view": "thread_view",
   "topics_sort_dir": "sort_none",
   "topic_sort_dir": "sort_none",
   "messages_sort_dir": "sort_none",
   "expanded_messages_sort_dir": "sort_none",
   "search_sort": "relevance_sort",
   "search_sort_dir": "sort_none",
   "photos_order_by": "",
   "photos_sort_dir": "sort_none",
   "album_order_by": "",
   "album_sort_dir": "sort_none",
   "default_calendar_view": "cal_view_month",
   "default_hashtag_view": "view_grid",
   "default_rsvp_view": "view_grid",
   "home_page": "home_page_feed"
}
View User definition

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).
default_hashtag_view
optional
string

Set the default hashtag view. Can be: hashtag_view_grid or hashtag_view_list.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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.
bad_request

"invalid default_hashtag_view" is returned if the provided default_hashtag_view is incorrect.
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

 {
   "id": 147779411,
   "object": "user",
   "created": "2020-09-01T08:47:00-07:00",
   "updated": "2022-03-01T17:18:00-08:00",
   "email": "gersonbeahan@jacobi.io",
   "full_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "status": "user_status_confirmed",
   "profile_photo_url": "",
   "post_pref": "user_postpref_html",
   "per_page_pref": "user_per_page_pref20",
   "allow_facebook_login": false,
   "allow_google_login": false,
   "allow_sso_login": false,
   "csrf_token": "84491575",
   "two_factor_enabled": false,
   "recovery_codes": "",
   "dont_munge_message_id": false,
   "about_me": "Today awfully arrive at",
   "about_format": "about_html",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "time_pref": "standard_time",
   "date_pref": "us_date",
   "monday_start": false,
   "profile_privacy": "profile_private",
   "default_message_view": "thread_view",
   "topics_sort_dir": "sort_none",
   "topic_sort_dir": "sort_none",
   "messages_sort_dir": "sort_none",
   "expanded_messages_sort_dir": "sort_none",
   "search_sort": "relevance_sort",
   "search_sort_dir": "sort_none",
   "photos_order_by": "",
   "photos_sort_dir": "sort_none",
   "album_order_by": "",
   "album_sort_dir": "sort_none",
   "default_calendar_view": "cal_view_month",
   "default_hashtag_view": "view_grid",
   "default_rsvp_view": "view_grid",
   "home_page": "home_page_feed"
}
View User definition

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 147779411,
   "object": "user",
   "created": "2020-09-01T08:47:00-07:00",
   "updated": "2022-03-01T17:18:00-08:00",
   "email": "gersonbeahan@jacobi.io",
   "full_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "status": "user_status_confirmed",
   "profile_photo_url": "",
   "post_pref": "user_postpref_html",
   "per_page_pref": "user_per_page_pref20",
   "allow_facebook_login": false,
   "allow_google_login": false,
   "allow_sso_login": false,
   "csrf_token": "84491575",
   "two_factor_enabled": false,
   "recovery_codes": "",
   "dont_munge_message_id": false,
   "about_me": "Today awfully arrive at",
   "about_format": "about_html",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "time_pref": "standard_time",
   "date_pref": "us_date",
   "monday_start": false,
   "profile_privacy": "profile_private",
   "default_message_view": "thread_view",
   "topics_sort_dir": "sort_none",
   "topic_sort_dir": "sort_none",
   "messages_sort_dir": "sort_none",
   "expanded_messages_sort_dir": "sort_none",
   "search_sort": "relevance_sort",
   "search_sort_dir": "sort_none",
   "photos_order_by": "",
   "photos_sort_dir": "sort_none",
   "album_order_by": "",
   "album_sort_dir": "sort_none",
   "default_calendar_view": "cal_view_month",
   "default_hashtag_view": "view_grid",
   "default_rsvp_view": "view_grid",
   "home_page": "home_page_feed"
}
View User definition

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
number

To change the profile photo for just one subscription, supply the member_info_id of that subscription.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 147779411,
   "object": "user",
   "created": "2020-09-01T08:47:00-07:00",
   "updated": "2022-03-01T17:18:00-08:00",
   "email": "gersonbeahan@jacobi.io",
   "full_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "status": "user_status_confirmed",
   "profile_photo_url": "",
   "post_pref": "user_postpref_html",
   "per_page_pref": "user_per_page_pref20",
   "allow_facebook_login": false,
   "allow_google_login": false,
   "allow_sso_login": false,
   "csrf_token": "84491575",
   "two_factor_enabled": false,
   "recovery_codes": "",
   "dont_munge_message_id": false,
   "about_me": "Today awfully arrive at",
   "about_format": "about_html",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "time_pref": "standard_time",
   "date_pref": "us_date",
   "monday_start": false,
   "profile_privacy": "profile_private",
   "default_message_view": "thread_view",
   "topics_sort_dir": "sort_none",
   "topic_sort_dir": "sort_none",
   "messages_sort_dir": "sort_none",
   "expanded_messages_sort_dir": "sort_none",
   "search_sort": "relevance_sort",
   "search_sort_dir": "sort_none",
   "photos_order_by": "",
   "photos_sort_dir": "sort_none",
   "album_order_by": "",
   "album_sort_dir": "sort_none",
   "default_calendar_view": "cal_view_month",
   "default_hashtag_view": "view_grid",
   "default_rsvp_view": "view_grid",
   "home_page": "home_page_feed"
}
View User definition

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
number

To delete the profile photo for just one subscription, supply the member_info_id of that subscription.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 147779411,
   "object": "user",
   "created": "2020-09-01T08:47:00-07:00",
   "updated": "2022-03-01T17:18:00-08:00",
   "email": "gersonbeahan@jacobi.io",
   "full_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "status": "user_status_confirmed",
   "profile_photo_url": "",
   "post_pref": "user_postpref_html",
   "per_page_pref": "user_per_page_pref20",
   "allow_facebook_login": false,
   "allow_google_login": false,
   "allow_sso_login": false,
   "csrf_token": "84491575",
   "two_factor_enabled": false,
   "recovery_codes": "",
   "dont_munge_message_id": false,
   "about_me": "Today awfully arrive at",
   "about_format": "about_html",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "time_pref": "standard_time",
   "date_pref": "us_date",
   "monday_start": false,
   "profile_privacy": "profile_private",
   "default_message_view": "thread_view",
   "topics_sort_dir": "sort_none",
   "topic_sort_dir": "sort_none",
   "messages_sort_dir": "sort_none",
   "expanded_messages_sort_dir": "sort_none",
   "search_sort": "relevance_sort",
   "search_sort_dir": "sort_none",
   "photos_order_by": "",
   "photos_sort_dir": "sort_none",
   "album_order_by": "",
   "album_sort_dir": "sort_none",
   "default_calendar_view": "cal_view_month",
   "default_hashtag_view": "view_grid",
   "default_rsvp_view": "view_grid",
   "home_page": "home_page_feed"
}
View User definition

Example Error Response

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

Get Subscription

Get a subscription to a single group.

Query Parameters
group_id
required
number

ID of the group.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

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
set_home_page
optional
boolean

If true, set the user's default home page to the Groups page.
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 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 group, approvals, size, activity, delivery.
sort_dir
optional
string

Sort direction. Can be asc or desc.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}
View Member Info List definition

Example Error Response

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

Resend Confirmation Email

Resend a confirmation email to a user with status user_status_not_confirmed.

Permissions Needed

None.

POST Parameters
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
"bad_request"

"user is not not confirmed" is returned if the user is not in the user_status_not_confirmed state.

POST /api/v1/resendconfirmationemail

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

Successful Response

HTTP 200

Example Error Response

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

Unbounce User

Unbounce a user.

Permissions Needed

None.

POST Parameters
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
"bad_request"

"user is not bouncing" is returned if the user is not in the user_status_bouncing or user_status_bounced state.

POST /api/v1/unbounceuser

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

Successful Response

HTTP 200

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
number

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.
chat_msg_notify
optional
string

Notify when someone posts a message to a chat you are subscribed to, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
like_notify
optional
string

Notify when someone likes a message you posted, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
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_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
pending_sub_notify
optional
string

Notify about pending subscriptions, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
sub_notify
optional
string

Notify when someone joins the group, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
storage_notify
optional
string

Notify when storage limits are reached, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
sub_group_notify
optional
string

Notify when a subgroup is created, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
message_report_notify
optional
string

Notify when someone reports a message, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
chat_notify
optional
string

Notify when someone starts a chat, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
photo_notify
optional
string

Notify when someone creates a photo album or uploads a photo, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
file_notify
optional
string

Notify when someone creates a folder or uploads a file, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
wiki_notify
optional
string

Notify when someone creates or modifies a wiki page, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, sub_notify_none
database_notify
optional
string

Notify when someone creates or modifies a database, can be: sub_notify_email_and_app, sub_notify_app_only, sub_notify_email_only, 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
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}
View Member Info definition

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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": ""
 }

Wikis

These are the API endpoints for wikis.

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
number

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a wiki page set 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

 {
   "page": {
     "id": 131773379,
     "object": "wiki_page",
     "created": "2020-09-02T18:27:00-07:00",
     "updated": "2021-01-10T20:19:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "title": "Example will addition yearly since",
     "path": "Example-will-addition-yearly-since",
     "locked": false,
     "rev_count": 22
   },
   "data": {
     "id": 59322191,
     "object": "wiki_data",
     "created": "2020-09-21T08:40:00-07:00",
     "updated": "2023-02-06T00:18:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Tonight to horror sleep over tea contrast line to say poorly out. According abundant unless nervously string lastly advertising faithfully it later depend deeply. Everybody rhythm for had does soften anyone anyway then to with wild. Hourly there she it infrequently power tonight several its which since tomorrow. Tonight your bag yourself our his which be itself mine this yesterday.\u003cbr/\u003eI smell us courageous some my poor troop frequently dynasty instance dive. Now door she exemplified tomato sedge Himalayan has define bale on this. Library promise us congregation backwards most that leap ream yearly occur her. Nobody are next party little hers hers today case towards herself African. Each our food nearby e.g. understand addition any infrequently idea she from.\u003cbr/\u003eWhich what always in have it eventually city under sleepy shake child. Early garden caused as become lazily wheelchair by her that exaltation homeless. Spoon now its her roll another what climb crew something body then. I fortnightly on must his never research scary band at fire man. Significant British few over before addition pack my whose this secondly that.",
     "edit_msg": "What them myself"
   },
   "sidebar": {
     "id": 19906119,
     "object": "wiki_data",
     "created": "2020-09-02T23:45:00-07:00",
     "updated": "2022-11-02T03:08:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Now conclude yourselves whose since shower quietly each in carry through innocence. What him his why hers they theirs who us who of this. That above youth with fashion tonight her seldom work also anyway what. Quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear usually body. Kilometer nightly child so firstly he next each secondly must catch politely.\u003cbr/\u003eSleepy where i.e. inquisitively yours wisp regularly nice cackle ourselves heavily now. This our yearly what few why where win most would everybody them. Backwards this that provided store elegance joy group Senegalese whichever happen trade. Move outside downstairs of exemplified up out destroy due taste anything where. This that would whom to cautiously till only himself fight our whomever.\u003cbr/\u003eThat for her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look fleet say. Still patrol finally Vietnamese painting otherwise its to a e.g. congregation cackle. Themselves previously in for theirs they my there road disappear accordingly hotel. So today by over have this Romanian abroad around while belong ever.",
     "edit_msg": "Into each whatever fortnightly he"
   },
   "footer": {
     "id": 120133809,
     "object": "wiki_data",
     "created": "2020-09-30T19:43:00-07:00",
     "updated": "2021-11-02T19:38:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Here swiftly his fly my one last then sit everyone they had. Mustering would as yesterday we inquire ourselves his laugh string several accordingly. Kindness bit stand woman just poised they enough thing homework each clothing. Other cry obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as out me.\u003cbr/\u003eWere Norwegian significant his do mob notice lastly theirs hotel one calm. That later does point throw neatly usually Kazakh without for one from. Soon swing whose man confusing case Bangladeshi how most somewhat several week. E.g. who earlier gentle catalog ourselves then tonight bend may yearly since. Limit e.g. besides chest their hair out work data sedge this might.\u003cbr/\u003eHow group out then result these preen numerous on frequently him at. Tonight is seriously why kiss logic beyond him swing our Amazonian will. For myself everybody I abundant few weekly anyone an weekly someone being. That her enthusiasm yours never without theirs mine that delay that the. Air whatever bundle you is such batch accommodation without now in yearly.",
     "edit_msg": "Adventurous her for previously as of along"
   }
}
View Wiki Page Set definition

Example Error Response

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

Update Wiki Page

Update an existing wiki page.

Permissions Needed

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

POST Parameters
group_id
required
number

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.
id
required
number

ID of the wiki page.
title
optional
string

The title of the wiki page.
body
optional
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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

Returns a wiki page set 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 id" is returned if the 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/updatewikipage

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

Example Successful Response

 {
   "page": {
     "id": 131773379,
     "object": "wiki_page",
     "created": "2020-09-02T18:27:00-07:00",
     "updated": "2021-01-10T20:19:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "title": "Example will addition yearly since",
     "path": "Example-will-addition-yearly-since",
     "locked": false,
     "rev_count": 22
   },
   "data": {
     "id": 59322191,
     "object": "wiki_data",
     "created": "2020-09-21T08:40:00-07:00",
     "updated": "2023-02-06T00:18:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Tonight to horror sleep over tea contrast line to say poorly out. According abundant unless nervously string lastly advertising faithfully it later depend deeply. Everybody rhythm for had does soften anyone anyway then to with wild. Hourly there she it infrequently power tonight several its which since tomorrow. Tonight your bag yourself our his which be itself mine this yesterday.\u003cbr/\u003eI smell us courageous some my poor troop frequently dynasty instance dive. Now door she exemplified tomato sedge Himalayan has define bale on this. Library promise us congregation backwards most that leap ream yearly occur her. Nobody are next party little hers hers today case towards herself African. Each our food nearby e.g. understand addition any infrequently idea she from.\u003cbr/\u003eWhich what always in have it eventually city under sleepy shake child. Early garden caused as become lazily wheelchair by her that exaltation homeless. Spoon now its her roll another what climb crew something body then. I fortnightly on must his never research scary band at fire man. Significant British few over before addition pack my whose this secondly that.",
     "edit_msg": "What them myself"
   },
   "sidebar": {
     "id": 19906119,
     "object": "wiki_data",
     "created": "2020-09-02T23:45:00-07:00",
     "updated": "2022-11-02T03:08:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Now conclude yourselves whose since shower quietly each in carry through innocence. What him his why hers they theirs who us who of this. That above youth with fashion tonight her seldom work also anyway what. Quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear usually body. Kilometer nightly child so firstly he next each secondly must catch politely.\u003cbr/\u003eSleepy where i.e. inquisitively yours wisp regularly nice cackle ourselves heavily now. This our yearly what few why where win most would everybody them. Backwards this that provided store elegance joy group Senegalese whichever happen trade. Move outside downstairs of exemplified up out destroy due taste anything where. This that would whom to cautiously till only himself fight our whomever.\u003cbr/\u003eThat for her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look fleet say. Still patrol finally Vietnamese painting otherwise its to a e.g. congregation cackle. Themselves previously in for theirs they my there road disappear accordingly hotel. So today by over have this Romanian abroad around while belong ever.",
     "edit_msg": "Into each whatever fortnightly he"
   },
   "footer": {
     "id": 120133809,
     "object": "wiki_data",
     "created": "2020-09-30T19:43:00-07:00",
     "updated": "2021-11-02T19:38:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Here swiftly his fly my one last then sit everyone they had. Mustering would as yesterday we inquire ourselves his laugh string several accordingly. Kindness bit stand woman just poised they enough thing homework each clothing. Other cry obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as out me.\u003cbr/\u003eWere Norwegian significant his do mob notice lastly theirs hotel one calm. That later does point throw neatly usually Kazakh without for one from. Soon swing whose man confusing case Bangladeshi how most somewhat several week. E.g. who earlier gentle catalog ourselves then tonight bend may yearly since. Limit e.g. besides chest their hair out work data sedge this might.\u003cbr/\u003eHow group out then result these preen numerous on frequently him at. Tonight is seriously why kiss logic beyond him swing our Amazonian will. For myself everybody I abundant few weekly anyone an weekly someone being. That her enthusiasm yours never without theirs mine that delay that the. Air whatever bundle you is such batch accommodation without now in yearly.",
     "edit_msg": "Adventurous her for previously as of along"
   }
}
View Wiki Page Set definition

Example Error Response

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

Delete Wiki Page

Delete an existing wiki page.

Permissions Needed

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

POST Parameters
group_id
required
number

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.
id
required
number

ID of the wiki page.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 group_id" is returned if the group id is missing or invalid.
"bad_request"

"invalid id" is returned if the id is missing or invalid.

POST /api/v1/deletewikipage

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

Successful Response

HTTP 200

Example Error Response

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

Delete Wiki Page Revision

Delete an existing wiki page revision.

Permissions Needed

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

POST Parameters
group_id
required
number

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.
id
required
number

ID of the wiki page.
data_id
required
number

ID of the wiki data object to delete.
csrf
required
string

The csrf_token from the user object returned when first logged in.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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 group_id" is returned if the group id is missing or invalid.
"bad_request"

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

"invalid data_id" is returned if the data_id is missing or invalid.

POST /api/v1/deletewikirevision

$ curl "https://groups.io/api/v1/deletewikirevision" \
-b "cookies.curl" \
-d group_id=12&id=10&data_id=1&csrf=1234

Successful Response

HTTP 200

Example Error Response

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

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 wiki_visible permission to use this call with a group.

Query Parameters
group_id
required
number

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
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
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

 {
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "wiki_page",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "title": "Example will addition",
       "path": "Example-will-addition",
       "locked": false,
       "rev_count": 47
     },
     {
       "id": 178561260,
       "object": "wiki_page",
       "created": "2020-09-08T11:43:00-07:00",
       "updated": "2022-04-14T04:30:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "title": "Him those tonight to",
       "path": "Him-those-tonight-to",
       "locked": false,
       "rev_count": 20
     },
     {
       "id": 174116746,
       "object": "wiki_page",
       "created": "2020-09-04T10:02:00-07:00",
       "updated": "2021-12-25T18:43:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "title": "Itself whose rather theirs additionally",
       "path": "Itself-whose-rather-theirs-additionally",
       "locked": false,
       "rev_count": 45
     }
   ]
}
View Wiki Page List definition

Example Error Response

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

Get Wiki Page Set

Get wiki page set.

Permissions Needed

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

Query Parameters
group_id
required
number

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. Either path or id must be specified.
id
required
number

ID of the wiki page to fetch. Either path or id must be specified.
extended
optional
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
"bad_request"

"invalid path" is returned if the path is invalid.
"bad_request"

"invalid id" is returned if the id is invalid.
"bad_request"

"missing path and id" is returned if neither the path or id are specified.
Notes

GET /api/v1/getwikipageset

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

Example Successful Response

 {
   "page": {
     "id": 131773379,
     "object": "wiki_page",
     "created": "2020-09-02T18:27:00-07:00",
     "updated": "2021-01-10T20:19:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "title": "Example will addition yearly since",
     "path": "Example-will-addition-yearly-since",
     "locked": false,
     "rev_count": 22
   },
   "data": {
     "id": 59322191,
     "object": "wiki_data",
     "created": "2020-09-21T08:40:00-07:00",
     "updated": "2023-02-06T00:18:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Tonight to horror sleep over tea contrast line to say poorly out. According abundant unless nervously string lastly advertising faithfully it later depend deeply. Everybody rhythm for had does soften anyone anyway then to with wild. Hourly there she it infrequently power tonight several its which since tomorrow. Tonight your bag yourself our his which be itself mine this yesterday.\u003cbr/\u003eI smell us courageous some my poor troop frequently dynasty instance dive. Now door she exemplified tomato sedge Himalayan has define bale on this. Library promise us congregation backwards most that leap ream yearly occur her. Nobody are next party little hers hers today case towards herself African. Each our food nearby e.g. understand addition any infrequently idea she from.\u003cbr/\u003eWhich what always in have it eventually city under sleepy shake child. Early garden caused as become lazily wheelchair by her that exaltation homeless. Spoon now its her roll another what climb crew something body then. I fortnightly on must his never research scary band at fire man. Significant British few over before addition pack my whose this secondly that.",
     "edit_msg": "What them myself"
   },
   "sidebar": {
     "id": 19906119,
     "object": "wiki_data",
     "created": "2020-09-02T23:45:00-07:00",
     "updated": "2022-11-02T03:08:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Now conclude yourselves whose since shower quietly each in carry through innocence. What him his why hers they theirs who us who of this. That above youth with fashion tonight her seldom work also anyway what. Quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear usually body. Kilometer nightly child so firstly he next each secondly must catch politely.\u003cbr/\u003eSleepy where i.e. inquisitively yours wisp regularly nice cackle ourselves heavily now. This our yearly what few why where win most would everybody them. Backwards this that provided store elegance joy group Senegalese whichever happen trade. Move outside downstairs of exemplified up out destroy due taste anything where. This that would whom to cautiously till only himself fight our whomever.\u003cbr/\u003eThat for her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look fleet say. Still patrol finally Vietnamese painting otherwise its to a e.g. congregation cackle. Themselves previously in for theirs they my there road disappear accordingly hotel. So today by over have this Romanian abroad around while belong ever.",
     "edit_msg": "Into each whatever fortnightly he"
   },
   "footer": {
     "id": 120133809,
     "object": "wiki_data",
     "created": "2020-09-30T19:43:00-07:00",
     "updated": "2021-11-02T19:38:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Here swiftly his fly my one last then sit everyone they had. Mustering would as yesterday we inquire ourselves his laugh string several accordingly. Kindness bit stand woman just poised they enough thing homework each clothing. Other cry obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as out me.\u003cbr/\u003eWere Norwegian significant his do mob notice lastly theirs hotel one calm. That later does point throw neatly usually Kazakh without for one from. Soon swing whose man confusing case Bangladeshi how most somewhat several week. E.g. who earlier gentle catalog ourselves then tonight bend may yearly since. Limit e.g. besides chest their hair out work data sedge this might.\u003cbr/\u003eHow group out then result these preen numerous on frequently him at. Tonight is seriously why kiss logic beyond him swing our Amazonian will. For myself everybody I abundant few weekly anyone an weekly someone being. That her enthusiasm yours never without theirs mine that delay that the. Air whatever bundle you is such batch accommodation without now in yearly.",
     "edit_msg": "Adventurous her for previously as of along"
   }
}
View Wiki Page Set definition

Example Error Response

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

Search Wikis

Search the wiki.

Permissions Needed

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

Query Parameters
group_id
required
number

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
required
string

The query string.
limit
optional
default is 10

A limit on the number of objects to be returned, between 1 and 100.
page_token
optional

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
boolean

If true, the endpoint will return additional information. See Extended Return Information for more information.
Returns

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

Additional Errors
"bad_request"

"missing query" is returned if the q parameter is not specified.

GET /api/v1/searchwikis

$ curl "https://groups.io/api/v1/searchwikis?group_id=12&q=find+this" \
-b "cookies.curl"

Example Successful Response

 {
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_id": 24,
 "query": "",
 "data": [
   {
    "id": 63,
    "object": "wiki_search_result",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 47,
    "data_id": 78,
    "title": "",
    "rev_count": 24,
    "body": "",
    "edit_msg": "",
    "snippet": "",
   }
 ],
}
View Wiki Search Results List definition

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 Activity Log Object

The activity log object. This represents an entry in the group activity log.

Response Attributes
id
number

ID of the draft attachment object.
object
string

activity_log.
created
date
group_id
number

ID of the group.
entry
string

The log entry, in HTML format.
via
string

How the log entry was generated. Can be one of: via_api, via_app, via_email, via_robot, via_slacksync, via_support, via_web.

Example Object

{
   "id": 131773379,
   "object": "activity_log",
   "created": "2020-09-02T18:27:00-07:00",
   "group_id": 73387781,
   "entry": "Integration \"testintegration\" sent  special notice #32",
   "via": "via_robot"
}

The Activity Log List Object

Activity Log 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 Activity Log objects
Methods That Use This Object
Get Activity Log

View Method

Example Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "activity_log",
       "created": "2020-09-04T00:33:00-07:00",
       "group_id": 73387781,
       "entry": "Integration \"testintegration\" sent  special notice #0",
       "via": "via_robot"
     },
     {
       "id": 178561260,
       "object": "activity_log",
       "created": "2020-09-08T11:43:00-07:00",
       "group_id": 73387781,
       "entry": "Integration \"testintegration\" sent  special notice #1",
       "via": "via_robot"
     },
     {
       "id": 174116746,
       "object": "activity_log",
       "created": "2020-09-04T10:02:00-07:00",
       "group_id": 73387781,
       "entry": "Integration \"testintegration\" sent  special notice #2",
       "via": "via_robot"
     }
   ]
}

The Add Error Object

The direct add results error object.

Response Attributes
object
string

direct_add_error.
email
string
alias_of
string
status
string

utils.DirectAddStatus.
group_id
number

Example Object

{
 "object": "direct_add_error",
 "email": "",
 "alias_of": "",
 "status": "",
 "group_id": 63,
}

The Album Object

The album object.

Response Attributes
id
number

Unique ID of the album object.
object
string

album.
created
date
updated
date
user_id
number
group_id
number
upload_perms
string
title
string

Title of the album.
desc
string

Description of the album in plain text.
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
optional
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.
cover_photo_thumbnail_url
optional
string

Thumbnail of cover photo.
cover_photo_url
optional
string

Photo to display.
total_photos
optional
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 Object

{
   "id": 131773379,
   "object": "album",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "upload_perms": "album_upload_group",
   "title": "Example will addition yearly since",
   "desc": "In these entirely itself whose rather.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 19
}

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 Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "album",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "upload_perms": "album_upload_group",
       "title": "Example will addition",
       "desc": "Yearly since in these entirely.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 18
     },
     {
       "id": 134081794,
       "object": "album",
       "created": "2020-09-26T00:35:00-07:00",
       "updated": "2023-02-05T22:45:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "upload_perms": "album_upload_group",
       "title": "Sleep over tea contrast",
       "desc": "Line to say poorly out according abundant unless.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 11
     },
     {
       "id": 120104241,
       "object": "album",
       "created": "2020-09-02T16:26:00-07:00",
       "updated": "2022-01-24T16:02:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "upload_perms": "album_upload_group",
       "title": "Say lastly advertising faithfully it",
       "desc": "Later depend deeply everybody rhythm for had does soften.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 27
     }
   ]
}

The Attachment Object

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

Response Attributes
id
string
object
string

attachment.
created
date
group_id
number
user_id
number

Who originally created this table.
thread_id
number
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 Object

{
 "id": "",
 "object": "attachment",
 "created": "2009-11-10T15:00:00-08:00",
 "group_id": 63,
 "user_id": 33,
 "thread_id": 47,
 "message_num": 78,
 "attach_num": 24,
 "type": "",
 "sub_type": "",
 "name": "",
 "content": "",
 "image_width": 59,
 "image_height": 53,
 "thumbnail_url": "",
}

The Attachment Object

Attachment information. Attachments have a media type. From that, you can determine the type of attachment it is. If the attachment is an image, the image_thumbnail_url is set.

Response Attributes
id
number

The ID of the attachment.
media_type
string

The media type of the attachment, lowercased.
download_url
string

URL to download the attachment.
image_thumbnail_url
string

If this is an image, the URL to get the image thumbnail for display.
filename
string

The filename of the attachment.

Example Object

{
 "id": 63,
 "media_type": "",
 "download_url": "",
 "image_thumbnail_url": "",
 "filename": "",
}

The Bounce Info Object

The bounce info object.

Response Attributes
object
string

bounce_info.
created
date
group_id
number

ID of the group.
msg_id
number

Message ID of the message we were attempting to send.
subject
string

Subject of the message we were attempting to send.
response
string

Response from the recipient server.
is_hard
boolean

If the bounce was a hard bounce.
type
string

Can be one of: delivery_bounce_probe, delivery_confirmation, delivery_digest, delivery_direct_add, delivery_invite, delivery_login_link, delivery_member_notice, delivery_mod_notice, delivery_reply, delivery_single, delivery_summary, delivery_to_owner, delivery_to_sub.

Example Object

{
 "object": "bounce_info",
 "created": "2009-11-10T15:00:00-08:00",
 "group_id": 63,
 "msg_id": 33,
 "subject": "",
 "response": "",
 "is_hard": false,
 "type": "delivery_bounce_probe",
}

The Bounce Info List Object

Bounce Info 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 Bounce Info objects
Methods That Use This Object
Get Bounce Info

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "bounce_info",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 63,
    "msg_id": 33,
    "subject": "",
    "response": "",
    "is_hard": false,
    "type": "delivery_bounce_probe",
   }
 ],
}

The Chat Object

The chat object.

Response Attributes
id
number

Unique ID of the chat object.
object
string

chat.
created
date
updated
date
user_id
number

ID of the person who created the chat.
profile_photo_url
string

If not empty then there is a profile photo associated with this votor.
name
string

Name of the person who voted.
can_view_profile
boolean

If the person viewing this poll can view the profile.
group_id
number

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 Object

{
   "id": 131773379,
   "object": "chat",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "profile_photo_url": "",
   "name": "",
   "can_view_profile": false,
   "group_id": 73387781,
   "subject": "Example.",
   "desc": "Will addition yearly.",
   "is_closed": false,
   "num_messages": 91,
   "chat_sub": {
     "id": 172646701,
     "object": "chat_sub",
     "created": "2020-09-20T18:09:00-07:00",
     "updated": "2022-09-22T09:25:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "chat_id": 131773379,
     "last_msg_seen": 157
   }
}

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 Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "chat",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 73387781,
       "subject": "Example.",
       "desc": "Will addition yearly.",
       "is_closed": false,
       "num_messages": 91,
       "chat_sub": {
         "id": 172646701,
         "object": "chat_sub",
         "created": "2020-09-07T18:08:00-07:00",
         "updated": "2022-09-25T00:35:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "chat_id": 131773379,
         "last_msg_seen": 157
       }
     },
     {
       "id": 87372696,
       "object": "chat",
       "created": "2020-09-30T14:36:00-07:00",
       "updated": "2022-06-29T13:41:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 73387781,
       "subject": "These.",
       "desc": "Entirely itself whose.",
       "is_closed": false,
       "num_messages": 61,
       "chat_sub": {
         "id": 155987616,
         "object": "chat_sub",
         "created": "2020-09-30T19:43:00-07:00",
         "updated": "2021-11-02T19:38:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "chat_id": 87372696,
         "last_msg_seen": 36
       }
     },
     {
       "id": 142876175,
       "object": "chat",
       "created": "2020-09-05T18:43:00-07:00",
       "updated": "2023-06-07T13:03:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 73387781,
       "subject": "Additionally.",
       "desc": "Line to say.",
       "is_closed": false,
       "num_messages": 63,
       "chat_sub": {
         "id": 179936620,
         "object": "chat_sub",
         "created": "2020-09-01T06:41:00-07:00",
         "updated": "2022-09-10T10:23:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "chat_id": 142876175,
         "last_msg_seen": 193
       }
     }
   ]
}

The Chat Message Object

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

Response Attributes
id
number

Unique ID of the chat_message object.
object
string

chat_message.
created
date
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
number

ID of the person who is subscribed.
group_id
number

ID of the group the chat is in.
chat_id
number

ID of the chat.
historical
boolean

If this message is not new/is being sent to populate the chat window.
type
string

Type of message. Can be one of: chat_msg_type_blur, chat_msg_type_closed, chat_msg_type_delete, chat_msg_type_first, chat_msg_type_focus, chat_msg_type_joined, chat_msg_type_left, chat_msg_type_normal, chat_msg_type_photo, chat_msg_type_update_tapbacks.
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.
delete_msg_num
number

If this is a delete message, this is the ID to delete.
photo_url
optional
string

If this is a photo message.
photo_width
number

Photo width.
photo_height
number

Photo height.
tapbacks
array of Chat Message Tapback objects
tapback_counts
array of Chat Message Tapback Count objects
display_name
string
user_name
string
profile_photo_url
string
profile_privacy
string

Privacy setting of the sender of the message.
profile_color
string

Color to use when displaying the sender's name, in hex.
email
string

Possibly obscured, depending on group settings.

Example Object

{
   "id": 172646701,
   "object": "chat_message",
   "created": "2020-09-20T18:09:00-07:00",
   "version": 2,
   "user_id": 147779411,
   "group_id": 73387781,
   "chat_id": 131773379,
   "historical": false,
   "type": "chat_msg_type_normal",
   "message": "In.",
   "msg_num": 0,
   "delete_msg_num": 0,
   "photo_width": 0,
   "photo_height": 0,
   "tapbacks": null,
   "tapback_counts": null,
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_photo_url": "",
   "profile_privacy": "profile_private",
   "profile_color": "#837fd5",
   "email": "gersonbeahan@..."
}

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 Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 172646701,
       "object": "chat_message",
       "created": "2020-09-07T18:08:00-07:00",
       "version": 2,
       "user_id": 147779411,
       "group_id": 73387781,
       "chat_id": 131773379,
       "historical": false,
       "type": "chat_msg_type_normal",
       "message": "In.",
       "msg_num": 0,
       "delete_msg_num": 0,
       "photo_width": 0,
       "photo_height": 0,
       "tapbacks": null,
       "tapback_counts": null,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 126702543,
       "object": "chat_message",
       "created": "2020-09-30T19:43:00-07:00",
       "version": 2,
       "user_id": 147779411,
       "group_id": 73387781,
       "chat_id": 98794901,
       "historical": false,
       "type": "chat_msg_type_normal",
       "message": "Contrast.",
       "msg_num": 0,
       "delete_msg_num": 0,
       "photo_width": 0,
       "photo_height": 0,
       "tapbacks": null,
       "tapback_counts": null,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 889509,
       "object": "chat_message",
       "created": "2020-09-01T06:41:00-07:00",
       "version": 2,
       "user_id": 147779411,
       "group_id": 73387781,
       "chat_id": 155038277,
       "historical": false,
       "type": "chat_msg_type_normal",
       "message": "Yesterday.",
       "msg_num": 0,
       "delete_msg_num": 0,
       "photo_width": 0,
       "photo_height": 0,
       "tapbacks": null,
       "tapback_counts": null,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     }
   ]
}

The Chat Message Tapback Object

Chat Message Tapback

Response Attributes
user_id
number
sub_id
number
type
string

Example Object

{
 "user_id": 63,
 "sub_id": 33,
 "type": "",
}

The Chat Message Tapback Count Object

Chat Message Tapback Count

Response Attributes
type
string
count
number

Example Object

{
 "type": "",
 "count": 63,
}

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 or chat_post_type_photo.
message
string

The chat message itself (dependant on the Type of chat message), in Markdown format.
photo_name
string

The photo data if this is of type chat_post_type_photo.
media_type
string
photo_data
string

Example Object

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

The Chat Sub Object

The chat subscription object.

Response Attributes
id
number

Unique ID of the draft object.
object
string

chat_sub.
created
date
updated
date
user_id
number

ID of the person who is subscribed.
group_id
number

ID of the group the chat is in.
chat_id
number

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 Object

{
   "id": 172646701,
   "object": "chat_sub",
   "created": "2020-09-20T18:09:00-07:00",
   "updated": "2022-09-22T09:25:00-07:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "chat_id": 131773379,
   "last_msg_seen": 157
}

The Database Column Object

The database column object. This defines a specific database column.

Response Attributes
id
number

Column ID.
name
string

Name of the column.
type
string

The column type. Can be one of: address, checkbox, date, html_paragraph, image, link, multi_choice, multiple_choice, number, paragraph, text, time.
required
boolean

The column cannot be empty.
color
string

Color of the row. Can be one of: color_antique_pink, color_apricot, color_aquamute, color_beige, color_bluejean, color_blush, color_burnt_yellow, color_capri_blue, color_cerulean_blue, color_cherry_blossom, color_cloudy_blue, color_cucumber, color_dark_grey, color_dark_orange, color_dusty_mauve, color_emerald_green, color_grape, color_green_lantern, color_green_sage, color_grey_blue, color_light_brown, color_light_grey, color_light_lilac, color_lilac, color_lips, color_melon, color_military, color_moss_green, color_mulbery, color_mustard, color_none, color_orange, color_orchid, color_peony, color_pink, color_purple, color_purple_blue, color_purple_grey, color_sage, color_sky, color_terracotta, color_tomato, color_yellow.
choices
optional
array of string

Titles of the choices for multi_choice and multiple_choice columns.
width
number

Width of the column (0 means not set/use the default).
default_hidden
boolean

The column should be hidden when you view the table initially.
profile
optional
boolean

If this column is a part of a member's profile, only used for extra member data columns.
description
string

Description of this column.
default_country
optional
string

For address columns, the default country.

Example Object

{
   "id": 131773379,
   "name": "Example will addition yearly since.",
   "type": "multiple_choice",
   "required": true,
   "color": "color_moss_green",
   "choices": [
     "Nervously string lastly advertising faithfully it.",
     "Later depend deeply everybody rhythm for.",
     "Had does soften anyone anyway then."
   ],
   "width": 0,
   "default_hidden": false,
   "description": "In these entirely itself whose rather theirs additionally line to."
}

The Database Row Object

The database row object. This defines all the values in one row of a database.

Response Attributes
id
number

Row ID.
object
string

databaserow.
created
date

Time that this row was first created.
updated
date

Time that this row was last updated.
group_id
number

ID of the group.
table_id
number

ID of the database_table object.
row_num
number

The table's max_row_id at the time of row creation.
vals
array of Database Value objects

Values for each column.
num_vals
number

Number of values.

Example Object

{
 "id": 63,
 "object": "databaserow",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 33,
 "table_id": 47,
 "row_num": 78,
 "vals": [
   {
    "col_id": 63,
    "col_type": "address",
    "text": "",
    "html_text": "",
    "date": "2009-11-10T15:00:00-08:00",
    "time": "2009-11-10T15:00:00-08:00",
    "checked": false,
    "multi_choice": [33],
    "street_address1": "",
    "street_address2": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "lat": "",
    "lng": "",
    "title": "",
    "url": "",
    "desc": "",
    "image_name": "",
    "number": "",
   }
 ],
 "num_vals": 47,
}

The Database Row List Object

Database Row 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 Database Row objects
Methods That Use This Object
Get Database Rows

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "databaserow",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "table_id": 47,
    "row_num": 78,
    "vals": [
      {
       "col_id": 63,
       "col_type": "address",
       "text": "",
       "html_text": "",
       "date": "2009-11-10T15:00:00-08:00",
       "time": "2009-11-10T15:00:00-08:00",
       "checked": false,
       "multi_choice": [33],
       "street_address1": "",
       "street_address2": "",
       "city": "",
       "state": "",
       "zip": "",
       "country": "",
       "lat": "",
       "lng": "",
       "title": "",
       "url": "",
       "desc": "",
       "image_name": "",
       "number": "",
      }
    ],
    "num_vals": 47,
   }
 ],
}

The Database Table Object

The database table object.

Response Attributes
id
number
object
string

databasetable.
created
date
updated
date
group_id
number
user_id
number

Who originally created this table.
name
string

Name of table.
short_desc
string
desc
string
desc_type
string

html, plain, markdown.
edit_table
string

Can be one of: database_access_all, database_access_restricted.
edit_rows
string

Can be one of: database_access_all, database_access_restricted.
add_rows
string

Can be one of: database_access_all, database_access_restricted.
view_table
string

Can be one of: database_access_all, database_access_restricted.
num_rows
number

Number of rows, not maintained automatically.
max_row_id
number

For setting DatabaseRow.RowID, not maintained automatically.
num_columns
number

Number of columns, automatically maintained.
max_col_id
number

For setting unique column ids.
display_template
string

Display template.
columns
array of Database Column objects
id_default_hidden
boolean

If the ID column should be hidden by default.
updated_default_hidden
boolean

If the Updated column should be hidden by default.

Example Object

{
 "id": 63,
 "object": "databasetable",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 33,
 "user_id": 47,
 "name": "",
 "short_desc": "",
 "desc": "",
 "desc_type": "",
 "edit_table": "database_access_all",
 "edit_rows": "database_access_all",
 "add_rows": "database_access_all",
 "view_table": "database_access_all",
 "num_rows": 78,
 "max_row_id": 24,
 "num_columns": 59,
 "max_col_id": 53,
 "display_template": "",
 "columns": [
   {
      "id": 131773379,
      "name": "Example will addition yearly since.",
      "type": "multiple_choice",
      "required": true,
      "color": "color_moss_green",
      "choices": [
        "Nervously string lastly advertising faithfully it.",
        "Later depend deeply everybody rhythm for.",
        "Had does soften anyone anyway then."
      ],
      "width": 0,
      "default_hidden": false,
      "description": "In these entirely itself whose rather theirs additionally line to."
   }
 ],
 "id_default_hidden": false,
 "updated_default_hidden": false,
}

The Database Table List Object

Database Table 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 Database Table objects
Methods That Use This Object
Get Databases

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "databasetable",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "user_id": 47,
    "name": "",
    "short_desc": "",
    "desc": "",
    "desc_type": "",
    "edit_table": "database_access_all",
    "edit_rows": "database_access_all",
    "add_rows": "database_access_all",
    "view_table": "database_access_all",
    "num_rows": 78,
    "max_row_id": 24,
    "num_columns": 59,
    "max_col_id": 53,
    "display_template": "",
    "columns": [
      {
         "id": 131773379,
         "name": "Example will addition yearly since.",
         "type": "multiple_choice",
         "required": true,
         "color": "color_moss_green",
         "choices": [
           "Nervously string lastly advertising faithfully it.",
           "Later depend deeply everybody rhythm for.",
           "Had does soften anyone anyway then."
         ],
         "width": 0,
         "default_hidden": false,
         "description": "In these entirely itself whose rather theirs additionally line to."
      }
    ],
    "id_default_hidden": false,
    "updated_default_hidden": false,
   }
 ],
}

The Database Value Object

The database value object. This defines a cell in the database.

Response Attributes
col_id
number

The column ID.
col_type
string

The column type. Can be one of: address, checkbox, date, html_paragraph, image, link, multi_choice, multiple_choice, number, paragraph, text, time.
text
optional
string

For columns of type text.
html_text
optional
string

For columns of type html_paragraph.
date
optional
date

For columns of type time.
time
optional
date

For columns of type date.
checked
optional
boolean

For columns of type checkbox.
multi_choice
optional
array of number

For columns of type multi_choice and multiple_choice.
street_address1
optional
string

For columns of type address.
street_address2
optional
string

For columns of type address.
city
optional
string

For columns of type address.
state
optional
string

For columns of type address.
zip
optional
string

For columns of type address.
country
optional
string

For columns of type address.
lat
optional
number

Google maps geocode latitude coordinate for address columns.
lng
optional
number

Google maps geocode longitude coordinate for address columns.
title
optional
string

For columns of type link.
url
optional
string

For columns of type link.
desc
optional
string

For columns of type link.
image_name
optional
string

For columns of type image.
number
optional
number

For columns of type number.

Example Object

{
 "col_id": 63,
 "col_type": "address",
 "text": "",
 "html_text": "",
 "date": "2009-11-10T15:00:00-08:00",
 "time": "2009-11-10T15:00:00-08:00",
 "checked": false,
 "multi_choice": [33],
 "street_address1": "",
 "street_address2": "",
 "city": "",
 "state": "",
 "zip": "",
 "country": "",
 "lat": "",
 "lng": "",
 "title": "",
 "url": "",
 "desc": "",
 "image_name": "",
 "number": "",
}

The Delivery Info Object

The delivery info object.

Response Attributes
object
string

delivery_info.
created
date
updated
date
group_id
number

ID of the group.
success_msg_id
number

most recent successful delivery.
success_time
date
success_subject
string
success_type
string

Can be one of: delivery_bounce_probe, delivery_confirmation, delivery_digest, delivery_direct_add, delivery_invite, delivery_login_link, delivery_member_notice, delivery_mod_notice, delivery_reply, delivery_single, delivery_summary, delivery_to_owner, delivery_to_sub.
success_response
string
attempt_msg_id
number

most recent attempted delivery.
attempt_time
date
attempt_subject
string
attempt_type
string

Can be one of: delivery_bounce_probe, delivery_confirmation, delivery_digest, delivery_direct_add, delivery_invite, delivery_login_link, delivery_member_notice, delivery_mod_notice, delivery_reply, delivery_single, delivery_summary, delivery_to_owner, delivery_to_sub.
attempt_response
string
bounces
array of Bounce Info objects

Bounces.
Methods That Use This Object
Get Delivery Info

View Method

Example Object

{
 "object": "delivery_info",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 63,
 "success_msg_id": 33,
 "success_time": "2009-11-10T15:00:00-08:00",
 "success_subject": "",
 "success_type": "delivery_bounce_probe",
 "success_response": "",
 "attempt_msg_id": 47,
 "attempt_time": "2009-11-10T15:00:00-08:00",
 "attempt_subject": "",
 "attempt_type": "delivery_bounce_probe",
 "attempt_response": "",
 "bounces": [
   {
    "object": "bounce_info",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 63,
    "msg_id": 33,
    "subject": "",
    "response": "",
    "is_hard": false,
    "type": "delivery_bounce_probe",
   }
 ],
}

The Direct Add Error Object

The direct add error object.

Response Attributes
object
string

direct_add_error.
email
string
alias_of
string
status
string

utils.DirectAddStatus.
group_id
number

Example Object

{
 "object": "direct_add_error",
 "email": "",
 "alias_of": "",
 "status": "",
 "group_id": 63,
}

The Direct Add Results Object

The direct add results object.

Response Attributes
object
string

direct_add_results.
total_emails
number
errors
array of Direct Add Error objects
added_members
array of Member Info objects
Methods That Use This Object
Direct Add

View Method
Send Invites

View Method

Example Object

{
 "object": "direct_add_results",
 "total_emails": 63,
 "errors": [
   {
    "object": "direct_add_error",
    "email": "",
    "alias_of": "",
    "status": "",
    "group_id": 63,
   }
 ],
 "added_members": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}

The Draft Object

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

Response Attributes
id
number

Unique ID of the draft object.
object
string

draft.
created
date
updated
date
user_id
number

ID of the user who created the draft.
group_id
number

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
number

The ID of the next attachment to be uploaded.
message_id
number

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 Object

{
 "id": 63,
 "object": "draft",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "draft_type": "",
 "subject": "",
 "body": "",
 "body_type": "",
 "is_special": false,
 "num_attachments": 78,
 "next_attachment_id": 24,
 "message_id": 59,
 "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
number

ID of the draft attachment object.
object
string

draft_attachment.
draft_id
number

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 Object

{
 "id": 63,
 "object": "draft_attachment",
 "draft_id": 33,
 "url": "",
 "filename": "",
 "size": 47,
 "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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "draft_attachment",
    "draft_id": 33,
    "url": "",
    "filename": "",
    "size": 47,
    "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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "draft",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 47,
    "draft_type": "",
    "subject": "",
    "body": "",
    "body_type": "",
    "is_special": false,
    "num_attachments": 78,
    "next_attachment_id": 24,
    "message_id": 59,
    "bcc_me": false,
    "bcc_all": false,
   }
 ],
}

The Enterprise Info Object

The enterprise object.

Response Attributes
object
string

enterprise_info.
domain
string
logo
array of byte

Example Object

{
 "object": "enterprise_info",
 "domain": "",
 "logo": [""],
}

The Error Object

The error object.

Response Attributes
object
string

error.
type
string
extra
string

Example Object

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

The Event Object

The event object.

Response Attributes
id
number

Unique ID of the rsvp object.
object
string

event.
created
date

The time that this object was created.
updated
date

The time that this object was last updated.
creator_name
string

Name of the person who created this event.
group_id
number

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
date

Start time of event.
end_time
date

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: color_antique_pink, color_apricot, color_aquamute, color_beige, color_bluejean, color_blush, color_burnt_yellow, color_capri_blue, color_cerulean_blue, color_cherry_blossom, color_cloudy_blue, color_cucumber, color_dark_grey, color_dark_orange, color_dusty_mauve, color_emerald_green, color_grape, color_green_lantern, color_green_sage, color_grey_blue, color_light_brown, color_light_grey, color_light_lilac, color_lilac, color_lips, color_melon, color_military, color_moss_green, color_mulbery, color_mustard, color_none, color_orange, color_orchid, color_peony, color_pink, color_purple, color_purple_blue, color_purple_grey, color_sage, color_sky, color_terracotta, color_tomato, color_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 Object

{
 "id": 63,
 "object": "event",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "creator_name": "@JohnSmith",
 "group_id": 33,
 "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": "color_antique_pink",
 "color_hex": "",
 "rsvp": false,
 "max_attendees": 47,
 "additional_guests": false,
 "comment_label": "",
 "yes_message": "",
 "has_rsvp": false,
 "rsvp_type": "",
 "rsvp_comment": "",
 "rsvp_additional_guests": 78,
}

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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "event",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "creator_name": "@JohnSmith",
    "group_id": 33,
    "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": "color_antique_pink",
    "color_hex": "",
    "rsvp": false,
    "max_attendees": 47,
    "additional_guests": false,
    "comment_label": "",
    "yes_message": "",
    "has_rsvp": false,
    "rsvp_type": "",
    "rsvp_comment": "",
    "rsvp_additional_guests": 78,
   }
 ],
}

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.
Methods That Use This Object
Get Single Feed

View Method

Example Object

{
 "object": "feed",
 "member_info": 
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   },
 "group": 
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   },
 "topics": [
   {
    "topic": 
      {
         "id": 131773379,
         "object": "topic",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "group_id": 73387781,
         "group_subject_tag": "[actually4]",
         "subject": "Them will addition yearly since in these entirely itself whose.",
         "summary": "Rather theirs additionally line to say.",
         "name": "Ladarius Swaniawski",
         "profile_photo_url": "",
         "num_messages": 27,
         "is_sticky": false,
         "is_moderated": false,
         "is_closed": false,
         "has_attachments": false,
         "reply_to": "thread_reply_group_default",
         "most_recent_message": "1969-12-31T16:00:00-08:00",
         "hashtags": null
      },
    "images": [
      {
       "id": "",
       "object": "attachment",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 63,
       "user_id": 33,
       "thread_id": 47,
       "message_num": 78,
       "attach_num": 24,
       "type": "",
       "sub_type": "",
       "name": "",
       "content": "",
       "image_width": 59,
       "image_height": 53,
       "thumbnail_url": "",
      }
    ],
   }
 ],
 "events": [
   {
    "id": 63,
    "object": "event",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "creator_name": "@JohnSmith",
    "group_id": 33,
    "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": "color_antique_pink",
    "color_hex": "",
    "rsvp": false,
    "max_attendees": 47,
    "additional_guests": false,
    "comment_label": "",
    "yes_message": "",
    "has_rsvp": false,
    "rsvp_type": "",
    "rsvp_comment": "",
    "rsvp_additional_guests": 78,
   }
 ],
 "files": [
   {
      "id": 131773379,
      "object": "file",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "name": "Seth White",
      "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
      "size": 197000002,
      "path": "topfolder/subfolder",
      "parent_folder_id": 0,
      "is_folder": false,
      "type": "file_type_file",
      "count": 2,
      "media_type": "text/plain",
      "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
      "display_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "profile_photo_url": "",
      "profile_privacy": "profile_private",
      "email": "gersonbeahan@..."
   }
 ],
 "photos": [
   {
      "id": 893,
      "object": "photo",
      "created": "2020-09-07T18:08:00-07:00",
      "updated": "2022-09-25T00:35:00-07:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "name": "Theirs additionally line",
      "desc": "To say poorly out according.",
      "media_type": "image/jpg",
      "size": 4060156,
      "attachment_num": 0,
      "width": 0,
      "height": 0,
      "album_id": 131773379,
      "display_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "profile_privacy": "profile_private",
      "email": "gersonbeahan@...",
      "format": "jpeg",
      "focal_length": 0,
      "iso": 0,
      "aperture": 0,
      "shutter_speed": 0,
      "taken": 0,
      "make": "",
      "model": ""
   }
 ],
 "chats": [
   {
      "id": 131773379,
      "object": "chat",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "user_id": 147779411,
      "profile_photo_url": "",
      "name": "",
      "can_view_profile": false,
      "group_id": 73387781,
      "subject": "Example.",
      "desc": "Will addition yearly.",
      "is_closed": false,
      "num_messages": 91,
      "chat_sub": {
        "id": 172646701,
        "object": "chat_sub",
        "created": "2020-09-20T18:09:00-07:00",
        "updated": "2022-09-22T09:25:00-07:00",
        "user_id": 147779411,
        "group_id": 73387781,
        "chat_id": 131773379,
        "last_msg_seen": 157
      }
   }
 ],
 "wikis": [
   {
      "id": 131773379,
      "object": "wiki_page",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "title": "Example will addition yearly since",
      "path": "Example-will-addition-yearly-since",
      "locked": false,
      "rev_count": 22
   }
 ],
 "subgroups": [
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   }
 ],
 "tables": [
   {
    "id": 63,
    "object": "databasetable",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "user_id": 47,
    "name": "",
    "short_desc": "",
    "desc": "",
    "desc_type": "",
    "edit_table": "database_access_all",
    "edit_rows": "database_access_all",
    "add_rows": "database_access_all",
    "view_table": "database_access_all",
    "num_rows": 78,
    "max_row_id": 24,
    "num_columns": 59,
    "max_col_id": 53,
    "display_template": "",
    "columns": [
      {
         "id": 131773379,
         "name": "Example will addition yearly since.",
         "type": "multiple_choice",
         "required": true,
         "color": "color_moss_green",
         "choices": [
           "Nervously string lastly advertising faithfully it.",
           "Later depend deeply everybody rhythm for.",
           "Had does soften anyone anyway then."
         ],
         "width": 0,
         "default_hidden": false,
         "description": "In these entirely itself whose rather theirs additionally line to."
      }
    ],
    "id_default_hidden": false,
    "updated_default_hidden": false,
   }
 ],
 "hashtags": [
   {
      "id": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   }
 ],
}

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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "feed",
    "member_info": 
      {
         "id": 93518468,
         "object": "member_info",
         "created": "2020-09-05T13:57:00-07:00",
         "updated": "2023-02-12T13:06:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "group_name": "actually4",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_single",
         "message_selection": "message_selection_all",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_unlimited",
         "approved_posts": 0,
         "mod_status": "sub_modstatus_owner",
         "pending_msg_notify": "sub_notify_email_and_app",
         "pending_sub_notify": "sub_notify_email_and_app",
         "sub_notify": "sub_notify_email_and_app",
         "storage_notify": "sub_notify_email_and_app",
         "sub_group_notify": "sub_notify_email_and_app",
         "message_report_notify": "sub_notify_email_and_app",
         "account_notify": "sub_notify_email_and_app",
         "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
         "owner_msg_notify": "sub_ownermsg_notify_subs",
         "chat_notify": "sub_notify_email_and_app",
         "photo_notify": "sub_notify_email_and_app",
         "file_notify": "sub_notify_email_and_app",
         "wiki_notify": "sub_notify_email_and_app",
         "database_notify": "sub_notify_email_and_app",
         "email": "gersonbeahan@jacobi.io",
         "user_status": "user_status_confirmed",
         "user_name": "Dickens6041",
         "timezone": "America/Chicago",
         "full_name": "Lawson Kreiger",
         "about_me": "Today awfully arrive at",
         "location": "Well away onto",
         "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "Growth one album",
         "color": "color_cerulean_blue",
         "cover_photo_url": "",
         "icon_url": "",
         "nice_group_name": "",
         "subs_count": 0,
         "most_recent_message": "0001-01-01T00:00:00Z",
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "extra_member_data": [
           {
             "col_id": 184312747,
             "col_type": "text",
             "text": "Other openly practically why gun it scold far hourly formerly."
           },
           {
             "col_id": 130018632,
             "col_type": "paragraph",
             "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
           },
           {
             "col_id": 158522530,
             "col_type": "checkbox",
             "checked": false
           },
           {
             "col_id": 77272575,
             "col_type": "multiple_choice"
           },
           {
             "col_id": 199150300,
             "col_type": "date",
             "date": "0001-01-01T00:00:00Z"
           },
           {
             "col_id": 139937550,
             "col_type": "time",
             "time": "1919-04-03T21:05:37.017498068Z"
           },
           {
             "col_id": 35163253,
             "col_type": "address",
             "street_address1": "56235 Club ton",
             "street_address2": "772 Port Valleys stad",
             "city": "Chandler",
             "state": "Nebraska",
             "zip": "58231",
             "country": "Gibraltar"
           },
           {
             "col_id": 22148015,
             "col_type": "multi_choice"
           },
           {
             "col_id": 23015426,
             "col_type": "link",
             "title": "Philippine before throughout wander of as there next of sleep.",
             "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
             "desc": "Cap today am terribly many because anyone does you hungrily."
           },
           {
             "col_id": 166687029,
             "col_type": "image",
             "url": "https://picsum.photos/id/83/200/300",
             "image_name": "Eastern with herself muster monthly it party another his ours."
           },
           {
             "col_id": 172741244,
             "col_type": "html_paragraph",
             "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
           }
         ]
      },
    "group": 
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      },
    "topics": [
      {
       "topic": 
         {
            "id": 131773379,
            "object": "topic",
            "created": "2020-09-02T18:27:00-07:00",
            "updated": "2021-01-10T20:19:00-08:00",
            "group_id": 73387781,
            "group_subject_tag": "[actually4]",
            "subject": "Them will addition yearly since in these entirely itself whose.",
            "summary": "Rather theirs additionally line to say.",
            "name": "Ladarius Swaniawski",
            "profile_photo_url": "",
            "num_messages": 27,
            "is_sticky": false,
            "is_moderated": false,
            "is_closed": false,
            "has_attachments": false,
            "reply_to": "thread_reply_group_default",
            "most_recent_message": "1969-12-31T16:00:00-08:00",
            "hashtags": null
         },
       "images": [
         {
          "id": "",
          "object": "attachment",
          "created": "2009-11-10T15:00:00-08:00",
          "group_id": 63,
          "user_id": 33,
          "thread_id": 47,
          "message_num": 78,
          "attach_num": 24,
          "type": "",
          "sub_type": "",
          "name": "",
          "content": "",
          "image_width": 59,
          "image_height": 53,
          "thumbnail_url": "",
         }
       ],
      }
    ],
    "events": [
      {
       "id": 63,
       "object": "event",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "creator_name": "@JohnSmith",
       "group_id": 33,
       "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": "color_antique_pink",
       "color_hex": "",
       "rsvp": false,
       "max_attendees": 47,
       "additional_guests": false,
       "comment_label": "",
       "yes_message": "",
       "has_rsvp": false,
       "rsvp_type": "",
       "rsvp_comment": "",
       "rsvp_additional_guests": 78,
      }
    ],
    "files": [
      {
         "id": 131773379,
         "object": "file",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "name": "Seth White",
         "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
         "size": 197000002,
         "path": "topfolder/subfolder",
         "parent_folder_id": 0,
         "is_folder": false,
         "type": "file_type_file",
         "count": 2,
         "media_type": "text/plain",
         "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
         "display_name": "Lawson Kreiger",
         "user_name": "Dickens6041",
         "profile_photo_url": "",
         "profile_privacy": "profile_private",
         "email": "gersonbeahan@..."
      }
    ],
    "photos": [
      {
         "id": 893,
         "object": "photo",
         "created": "2020-09-07T18:08:00-07:00",
         "updated": "2022-09-25T00:35:00-07:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "name": "Theirs additionally line",
         "desc": "To say poorly out according.",
         "media_type": "image/jpg",
         "size": 4060156,
         "attachment_num": 0,
         "width": 0,
         "height": 0,
         "album_id": 131773379,
         "display_name": "Lawson Kreiger",
         "user_name": "Dickens6041",
         "profile_privacy": "profile_private",
         "email": "gersonbeahan@...",
         "format": "jpeg",
         "focal_length": 0,
         "iso": 0,
         "aperture": 0,
         "shutter_speed": 0,
         "taken": 0,
         "make": "",
         "model": ""
      }
    ],
    "chats": [
      {
         "id": 131773379,
         "object": "chat",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "user_id": 147779411,
         "profile_photo_url": "",
         "name": "",
         "can_view_profile": false,
         "group_id": 73387781,
         "subject": "Example.",
         "desc": "Will addition yearly.",
         "is_closed": false,
         "num_messages": 91,
         "chat_sub": {
           "id": 172646701,
           "object": "chat_sub",
           "created": "2020-09-20T18:09:00-07:00",
           "updated": "2022-09-22T09:25:00-07:00",
           "user_id": 147779411,
           "group_id": 73387781,
           "chat_id": 131773379,
           "last_msg_seen": 157
         }
      }
    ],
    "wikis": [
      {
         "id": 131773379,
         "object": "wiki_page",
         "created": "2020-09-02T18:27:00-07:00",
         "updated": "2021-01-10T20:19:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "title": "Example will addition yearly since",
         "path": "Example-will-addition-yearly-since",
         "locked": false,
         "rev_count": 22
      }
    ],
    "subgroups": [
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      }
    ],
    "tables": [
      {
       "id": 63,
       "object": "databasetable",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "group_id": 33,
       "user_id": 47,
       "name": "",
       "short_desc": "",
       "desc": "",
       "desc_type": "",
       "edit_table": "database_access_all",
       "edit_rows": "database_access_all",
       "add_rows": "database_access_all",
       "view_table": "database_access_all",
       "num_rows": 78,
       "max_row_id": 24,
       "num_columns": 59,
       "max_col_id": 53,
       "display_template": "",
       "columns": [
         {
            "id": 131773379,
            "name": "Example will addition yearly since.",
            "type": "multiple_choice",
            "required": true,
            "color": "color_moss_green",
            "choices": [
              "Nervously string lastly advertising faithfully it.",
              "Later depend deeply everybody rhythm for.",
              "Had does soften anyone anyway then."
            ],
            "width": 0,
            "default_hidden": false,
            "description": "In these entirely itself whose rather theirs additionally line to."
         }
       ],
       "id_default_hidden": false,
       "updated_default_hidden": false,
      }
    ],
    "hashtags": [
      {
         "id": 1758,
         "object": "hashtag",
         "created": "2020-09-16T20:58:00-07:00",
         "group_id": 903,
         "name": "Barney Parisian",
         "mods_only_post": true,
         "mods_only_replies": false,
         "no_email": true,
         "moderated": true,
         "special": true,
         "replies_unmoderated": false,
         "locked": true,
         "until": "hashtag_delete_month",
         "close_instead_of_delete": false,
         "description": "Them will addition yearly since in these entirely itself.",
         "color_name": "bluejean",
         "color_hex": "#8ec2ee",
         "reply_to": "thread_reply_to_sender",
         "topic_count": 1162,
         "last_message_date": "2020-09-28T03:08:00-07:00",
         "muted": null,
         "followed": null
      }
    ],
   }
 ],
}

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 Object

{
 "topic": 
   {
      "id": 131773379,
      "object": "topic",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "group_id": 73387781,
      "group_subject_tag": "[actually4]",
      "subject": "Them will addition yearly since in these entirely itself whose.",
      "summary": "Rather theirs additionally line to say.",
      "name": "Ladarius Swaniawski",
      "profile_photo_url": "",
      "num_messages": 27,
      "is_sticky": false,
      "is_moderated": false,
      "is_closed": false,
      "has_attachments": false,
      "reply_to": "thread_reply_group_default",
      "most_recent_message": "1969-12-31T16:00:00-08:00",
      "hashtags": null
   },
 "images": [
   {
    "id": "",
    "object": "attachment",
    "created": "2009-11-10T15:00:00-08:00",
    "group_id": 63,
    "user_id": 33,
    "thread_id": 47,
    "message_num": 78,
    "attach_num": 24,
    "type": "",
    "sub_type": "",
    "name": "",
    "content": "",
    "image_width": 59,
    "image_height": 53,
    "thumbnail_url": "",
   }
 ],
}

The File Object

The file object.

Response Attributes
id
number
object
string

file.
created
date
updated
date
user_id
number
group_id
number
name
string
desc
string
size
number
path
string

The path to get to this file or folder.
parent_folder_id
number

If this is a sub folder, this is the ID of the parent folder.
type
string

Type of object this record represents.
count
number

If this is a directory, how many items are within it.
media_type
optional
string

If this is a file, the media type.
download_url
optional
string
display_name
optional
string
user_name
optional
string
profile_photo_url
optional
string
profile_privacy
optional
string

Privacy setting of the sender of the message.
email
optional
string

Possibly obscured, depending on group settings.
Methods That Use This Object
Get File

View Method

Example Object

{
   "id": 131773379,
   "object": "file",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "name": "Seth White",
   "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
   "size": 197000002,
   "path": "topfolder/subfolder",
   "parent_folder_id": 0,
   "is_folder": false,
   "type": "file_type_file",
   "count": 2,
   "media_type": "text/plain",
   "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_photo_url": "",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@..."
}

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
Add Files

View Method
Add Link

View Method
Get File Directory

View Method
Search Files

View Method
Delete File

View Method

Example Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 131773379,
       "object": "file",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Seth White",
       "desc": "Christian keep Sammarinese yearly since in these entirely itself whose.",
       "size": 197000002,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/131773379/Seth%20White?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=g7HkeAcVykuWxDhrsR4kkFpV9Ic%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 92742948,
       "object": "file",
       "created": "2020-09-07T18:08:00-07:00",
       "updated": "2022-09-25T00:35:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Burnice Rau",
       "desc": "Another fly she it infrequently power tonight several its which.",
       "size": 3477666,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/92742948/Burnice%20Rau?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=wp2UWrODAbzJ0oMC9jrlMHYKnEc%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 65238498,
       "object": "file",
       "created": "2020-09-30T14:36:00-07:00",
       "updated": "2022-06-29T13:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Maximillia Gottlieb",
       "desc": "Hourly him Polynesian nose guitar government whose example congregation backwards.",
       "size": 135468236,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "is_folder": false,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/73387781/65238498/Maximillia%20Gottlieb?AWSAccessKeyId=\u0026Expires=1672959773\u0026Signature=fxgvdcZT%2Bvi%2BHVhYX2jwRnZA%2BMQ%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}

The Group Object

The group object.

Response Attributes
id
number

Unique ID of the group object.
object
string

group.
created
date
updated
date
type
string

Type of group.
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
moderation
string

Can be one of: moderate_first_message, moderated, no_moderation.
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_followers_only, 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.
sub_group_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_mods_folders_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_mods_folders_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_mods_folders_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_mods_folders_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_mods_folders_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_mods_folders_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_mods_folders_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.
plan
string

What plan is group is set to. Can be one of: group_plan_basic, group_plan_enterprise, group_plan_premium.
trial_group
boolean

If the group is a free-trial group.
has_cover_photo
boolean
has_icon
boolean
parent_group_id
number
org_id
number
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_color
string

Can be one of: color_antique_pink, color_apricot, color_aquamute, color_beige, color_bluejean, color_blush, color_burnt_yellow, color_capri_blue, color_cerulean_blue, color_cherry_blossom, color_cloudy_blue, color_cucumber, color_dark_grey, color_dark_orange, color_dusty_mauve, color_emerald_green, color_grape, color_green_lantern, color_green_sage, color_grey_blue, color_light_brown, color_light_grey, color_light_lilac, color_lilac, color_lips, color_melon, color_military, color_moss_green, color_mulbery, color_mustard, color_none, color_orange, color_orchid, color_peony, color_pink, color_purple, color_purple_blue, color_purple_grey, color_sage, color_sky, color_terracotta, color_tomato, color_yellow.
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.
sticky_wiki_page_id
number

If we've set a wiki page to be displayed at the top of messages.
sub_group_categoryid
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
optional
number

Number of pending subscribers, for restricted groups.
pending_msgs_count
optional
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
date
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_biweekly_friday, event_summary_monthly, event_summary_weekly_friday, event_summary_weekly_monday, event_summary_weekly_saturday, event_summary_weekly_sunday, event_summary_weekly_thursday, event_summary_weekly_tuesday, event_summary_weekly_wednesday.
send_invites_on_join
boolean
perms
optional
Perms object

If you are subscribed to the group, these are the permissions you have.
email_address
string

Email address of the group.
extra_member_data_columns
optional
array of Database Column objects
Methods That Use This Object
Create Group

View Method
Create Sub Group

View Method
Get Group Settings

View Method
Update Group

View Method
Add New Group Alias

View Method
Delete Group Alias

View Method

Example Object

{
   "id": 73387781,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "actually4",
   "nice_group_name": "",
   "alias": "",
   "desc": "This is a test group",
   "plain_desc": "This is a test group",
   "subject_tag": "[actually4]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "allow_non_subs_to_post": false,
   "force_html_emails": false,
   "normalize_html_emails": false,
   "reply_to": "group_reply_to_group",
   "remove_other_reply_options": false,
   "privacy": "group_privacy_none",
   "seperate_footers": false,
   "allow_downloads": "allow_downloads_no",
   "members_visible": "group_view_members_moderators",
   "sub_group_access": "sub_group_subs",
   "calendar_access": "group_access_subscribers",
   "files_access": "group_access_subscribers",
   "database_access": "group_access_subscribers",
   "wiki_access": "group_access_subscribers",
   "photos_access": "group_access_subscribers",
   "member_directory_access": "group_access_subscribers",
   "polls_access": "polls_access_subscribers",
   "chat_access": "group_access_subscribers",
   "handle_attachments": "group_attachments_normal",
   "plain_text_only": false,
   "handle_virus": "handle_virus_block",
   "locked": false,
   "plan": "group_plan_premium",
   "trial_group": false,
   "has_cover_photo": false,
   "has_icon": false,
   "parent_group_id": 0,
   "org_id": 1,
   "max_photo_size_email": "max_photo_size_none",
   "max_photo_size_photos": "max_photo_size_none",
   "max_photo_size_databases": "max_photo_size_none",
   "max_photo_size_wiki_images": "max_photo_size_none",
   "hash_tags_required": false,
   "hash_tag_permissions": "hash_tag_create_subs",
   "bounce_attachments": false,
   "allow_photos_in_files": false,
   "allow_reposts": false,
   "min_days_between_reposts": 0,
   "max_number_of_reposts": 0,
   "email_delivery_default": "email_delivery_single",
   "message_selection_default": "message_selection_all",
   "auto_follow_replies_default": false,
   "max_attachment_size_default": "max_attachment_size_small",
   "default_color": "color_cerulean_blue",
   "default_timezone": "America/Los_Angeles",
   "default_time_pref": "standard_time",
   "default_date_pref": "us_date",
   "default_monday_start": false,
   "disable_edits": false,
   "disable_no_email": false,
   "auto_close_threads": false,
   "close_threads_after": 0,
   "auto_moderate_threads": false,
   "moderate_threads_after": 0,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 361,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "1969-12-31T16: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_weekly_friday",
   "send_invites_on_join": false,
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "email_address": "actually4@groups.io",
   "extra_member_data_columns": [
     {
       "id": 184312747,
       "name": "Collection dream week that be.",
       "type": "text",
       "required": true,
       "color": "color_mulbery",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "So which archipelago wicked along width whom exaltation himself how."
     },
     {
       "id": 130018632,
       "name": "These execute toast whose have.",
       "type": "paragraph",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Why themselves the huge been we something honesty sing as."
     },
     {
       "id": 158522530,
       "name": "Whom whose heap been regularly.",
       "type": "checkbox",
       "required": true,
       "color": "color_lilac",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Build in this how today nearly carrot are near right."
     },
     {
       "id": 77272575,
       "name": "Onion of how product write.",
       "type": "multiple_choice",
       "required": true,
       "color": "color_cloudy_blue",
       "choices": [
         "Covey range window silence lastly had.",
         "What outcome let while school pause.",
         "Up anxiously today whom itself sleep."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Point week doctor movement whose also it vanish watch these."
     },
     {
       "id": 199150300,
       "name": "Quarterly outfit faithful is often.",
       "type": "date",
       "required": true,
       "color": "color_green_lantern",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Part whom these been hourly then smell then under lastly."
     },
     {
       "id": 139937550,
       "name": "Besides pack when murder her.",
       "type": "time",
       "required": true,
       "color": "color_grape",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Had snore first in limp through first open towards besides."
     },
     {
       "id": 35163253,
       "name": "Black monthly ball upon almost.",
       "type": "address",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
     },
     {
       "id": 22148015,
       "name": "Orchard what far upon which.",
       "type": "multi_choice",
       "required": true,
       "color": "color_orange",
       "choices": [
         "Cheese at kiss rarely each her.",
         "Ski ours host our as did.",
         "They to money such this as."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "These bale nobody few how anyone these string life that."
     },
     {
       "id": 23015426,
       "name": "Regularly nearby twist how time.",
       "type": "link",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Yourselves hungry those right empty none another what full her."
     },
     {
       "id": 166687029,
       "name": "Mob nose his me much.",
       "type": "image",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Bathe whoever afterwards myself mine to his how woman no."
     },
     {
       "id": 172741244,
       "name": "Half am yesterday must why.",
       "type": "html_paragraph",
       "required": true,
       "color": "color_none",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
     }
   ]
}

The Group Alias Object

The group alias object.

Response Attributes
id
number
object
string

groupalias.
created
date
updated
date
name
string

Name.
alias_group_id
number

If not 0, this is not a real group, but an alias to another group.

Example Object

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

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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "groupalias",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "name": "example",
    "alias_group_id": 33,
   }
 ],
}

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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   }
 ],
}

The Hashtag Object

The hashtag object.

Response Attributes
id
number

Unique ID of the hashtag object.
object
string

hashtag.
created
date
group_id
number
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: hashtag_delete_day, hashtag_delete_forever, hashtag_delete_hour, hashtag_delete_month, hashtag_delete_six_months, hashtag_delete_three_months, hashtag_delete_week, hashtag_delete_year.
close_instead_of_delete
boolean
description
string
color_name
string

Can be one of: color_antique_pink, color_apricot, color_aquamute, color_beige, color_bluejean, color_blush, color_burnt_yellow, color_capri_blue, color_cerulean_blue, color_cherry_blossom, color_cloudy_blue, color_cucumber, color_dark_grey, color_dark_orange, color_dusty_mauve, color_emerald_green, color_grape, color_green_lantern, color_green_sage, color_grey_blue, color_light_brown, color_light_grey, color_light_lilac, color_lilac, color_lips, color_melon, color_military, color_moss_green, color_mulbery, color_mustard, color_none, color_orange, color_orchid, color_peony, color_pink, color_purple, color_purple_blue, color_purple_grey, color_sage, color_sky, color_terracotta, color_tomato, color_yellow.
color_hex
string
reply_to
string

Can be one of: thread_reply_group_default, thread_reply_only_to_sender, thread_reply_to_followers_only, thread_reply_to_group, thread_reply_to_group_and_sender, thread_reply_to_moderators, thread_reply_to_sender.
topic_count
number
last_message_date
date
muted
boolean

If true, the user is muting this hashtag. This is an optional field.
followed
boolean

If true, the user is following this hashtag. This is an optional field.
Methods That Use This Object
New Hashtag

View Method
Update Hashtag

View Method

Example Object

{
   "id": 1758,
   "object": "hashtag",
   "created": "2020-09-16T20:58:00-07:00",
   "group_id": 903,
   "name": "Barney Parisian",
   "mods_only_post": true,
   "mods_only_replies": false,
   "no_email": true,
   "moderated": true,
   "special": true,
   "replies_unmoderated": false,
   "locked": true,
   "until": "hashtag_delete_month",
   "close_instead_of_delete": false,
   "description": "Them will addition yearly since in these entirely itself.",
   "color_name": "bluejean",
   "color_hex": "#8ec2ee",
   "reply_to": "thread_reply_to_sender",
   "topic_count": 1162,
   "last_message_date": "2020-09-28T03:08:00-07:00",
   "muted": null,
   "followed": null
}

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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   }
 ],
}

The Login Object

The login object.

Response Attributes
user
User object
token
optional
string

If using the token login, this is the token to pass in.
Methods That Use This Object
Login

View Method
Authenticate Login Link

View Method
Facebook Login Final

View Method
Apple Login Final

View Method
Google Login Final

View Method
Register User

View Method

Example Object

{
 "user": 
   {
      "id": 147779411,
      "object": "user",
      "created": "2020-09-01T08:47:00-07:00",
      "updated": "2022-03-01T17:18:00-08:00",
      "email": "gersonbeahan@jacobi.io",
      "full_name": "Lawson Kreiger",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "status": "user_status_confirmed",
      "profile_photo_url": "",
      "post_pref": "user_postpref_html",
      "per_page_pref": "user_per_page_pref20",
      "allow_facebook_login": false,
      "allow_google_login": false,
      "allow_sso_login": false,
      "csrf_token": "84491575",
      "two_factor_enabled": false,
      "recovery_codes": "",
      "dont_munge_message_id": false,
      "about_me": "Today awfully arrive at",
      "about_format": "about_html",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "time_pref": "standard_time",
      "date_pref": "us_date",
      "monday_start": false,
      "profile_privacy": "profile_private",
      "default_message_view": "thread_view",
      "topics_sort_dir": "sort_none",
      "topic_sort_dir": "sort_none",
      "messages_sort_dir": "sort_none",
      "expanded_messages_sort_dir": "sort_none",
      "search_sort": "relevance_sort",
      "search_sort_dir": "sort_none",
      "photos_order_by": "",
      "photos_sort_dir": "sort_none",
      "album_order_by": "",
      "album_sort_dir": "sort_none",
      "default_calendar_view": "cal_view_month",
      "default_hashtag_view": "view_grid",
      "default_rsvp_view": "view_grid",
      "home_page": "home_page_feed"
   },
 "token": "aabbffed2213234",
}

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
number

Unique ID of the member_info object.
object
string

member_info.
created
date

The time that this object was created.
updated
date

The time that this object was last updated.
user_id
number

ID of the member.
group_id
number

ID of the group.
group_name
string

Name of the group.
status
optional
string

Member status. Can be one of: sub_status_banned, sub_status_normal, sub_status_pending.
post_status
optional
string

Posting status. Can be one of: sub_poststatus_allowed, sub_poststatus_mod_first_message, sub_poststatus_mod_started_topics, sub_poststatus_moderated, sub_poststatus_newusermoderated, sub_poststatus_normal, sub_poststatus_notallowed.
email_delivery
optional
string

Email delivery. 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

Message selection. 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

Max attachment size. 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_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
pending_sub_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
sub_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
storage_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
sub_group_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
message_report_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
account_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
mod_permissions
optional
string

Can be more than one of: sub_perm_banmembers, sub_perm_billing, sub_perm_editarchives, sub_perm_groupsettings, sub_perm_integrations, sub_perm_invitemembers, sub_perm_makemoderator, sub_perm_managehashtags, 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.
chat_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
photo_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
file_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
wiki_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
database_notify
optional
string

Can be one of: sub_notify_app_only, sub_notify_email_and_app, sub_notify_email_only, sub_notify_none.
email
optional
string

The email address of the member.
user_status
optional
string

User status. Can be one of: user_status_bounced, user_status_bouncing, user_status_confirmed, user_status_inactive, user_status_not_confirmed.
user_name
string

User name.
timezone
optional
string

Time zone.
full_name
string

Full name.
about_me
optional
string

About me, in HTML format.
location
optional
string

Location.
website
optional
string

Website, typically a URL.
profile_photo_url
optional
string

Empty if no profile photo.
profile_privacy
optional
string

Profile privacy. Can be one of: profile_members, profile_private, profile_public.
dont_munge_message_id
optional
boolean
use_signature
optional
boolean

Insert the signature into messages posted from the Groups.io website.
use_signature_email
optional
boolean

Insert the signature into messages sent via email.
signature
optional
string

Signature.
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
date

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.
color
optional
string

Member color. Can be one of: color_antique_pink, color_apricot, color_aquamute, color_beige, color_bluejean, color_blush, color_burnt_yellow, color_capri_blue, color_cerulean_blue, color_cherry_blossom, color_cloudy_blue, color_cucumber, color_dark_grey, color_dark_orange, color_dusty_mauve, color_emerald_green, color_grape, color_green_lantern, color_green_sage, color_grey_blue, color_light_brown, color_light_grey, color_light_lilac, color_lilac, color_lips, color_melon, color_military, color_moss_green, color_mulbery, color_mustard, color_none, color_orange, color_orchid, color_peony, color_pink, color_purple, color_purple_blue, color_purple_grey, color_sage, color_sky, color_terracotta, color_tomato, color_yellow.
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.
cover_photo_url
string

URL of the group cover photo.
icon_url
string

URL of the group icon.
nice_group_name
string

Nice version of the group name.
subs_count
number

Number of subscribers in the group.
most_recent_message
date
perms
optional
Perms object

Group permissions this member has.
delivery_info
optional
Delivery Info object

Delivery information.
extra_member_data
optional
array of Database Value objects

Extra member data.
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 Object

{
   "id": 93518468,
   "object": "member_info",
   "created": "2020-09-05T13:57:00-07:00",
   "updated": "2023-02-12T13:06:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "group_name": "actually4",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_single",
   "message_selection": "message_selection_all",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_unlimited",
   "approved_posts": 0,
   "mod_status": "sub_modstatus_owner",
   "pending_msg_notify": "sub_notify_email_and_app",
   "pending_sub_notify": "sub_notify_email_and_app",
   "sub_notify": "sub_notify_email_and_app",
   "storage_notify": "sub_notify_email_and_app",
   "sub_group_notify": "sub_notify_email_and_app",
   "message_report_notify": "sub_notify_email_and_app",
   "account_notify": "sub_notify_email_and_app",
   "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
   "owner_msg_notify": "sub_ownermsg_notify_subs",
   "chat_notify": "sub_notify_email_and_app",
   "photo_notify": "sub_notify_email_and_app",
   "file_notify": "sub_notify_email_and_app",
   "wiki_notify": "sub_notify_email_and_app",
   "database_notify": "sub_notify_email_and_app",
   "email": "gersonbeahan@jacobi.io",
   "user_status": "user_status_confirmed",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "full_name": "Lawson Kreiger",
   "about_me": "Today awfully arrive at",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "Growth one album",
   "color": "color_cerulean_blue",
   "cover_photo_url": "",
   "icon_url": "",
   "nice_group_name": "",
   "subs_count": 0,
   "most_recent_message": "0001-01-01T00:00:00Z",
   "perms": {
     "object": "perms",
     "archives_visible": true,
     "polls_visible": true,
     "members_visible": true,
     "chat_visible": true,
     "calendar_visible": true,
     "files_visible": true,
     "database_visible": true,
     "photos_visible": true,
     "wiki_visible": true,
     "member_directory_visible": true,
     "hashtags_visible": true,
     "guidelines_visible": true,
     "subgroups_visible": true,
     "open_donations_visible": true,
     "sponsor_visible": true,
     "manage_subgroups": true,
     "delete_group": true,
     "download_archives": true,
     "download_entire_group": true,
     "download_members": true,
     "view_activity": true,
     "create_hashtags": true,
     "manage_hashtags": true,
     "manage_integrations": true,
     "manage_group_settings": true,
     "make_moderator": true,
     "manage_member_subscription_options": true,
     "manage_pending_members": true,
     "remove_members": true,
     "ban_members": true,
     "manage_group_billing": true,
     "manage_group_payments": true,
     "edit_archives": true,
     "manage_pending_messages": true,
     "invite_members": true,
     "can_post": true,
     "can_vote": true,
     "manage_polls": true,
     "manage_photos": true,
     "manage_members": true,
     "manage_calendar": true,
     "manage_chats": true,
     "view_member_directory": true,
     "manage_files": true,
     "manage_wiki": true,
     "manage_subscription": true,
     "public_page": true,
     "sub_page": true,
     "mod_page": true
   },
   "extra_member_data": [
     {
       "col_id": 184312747,
       "col_type": "text",
       "text": "Other openly practically why gun it scold far hourly formerly."
     },
     {
       "col_id": 130018632,
       "col_type": "paragraph",
       "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
     },
     {
       "col_id": 158522530,
       "col_type": "checkbox",
       "checked": false
     },
     {
       "col_id": 77272575,
       "col_type": "multiple_choice"
     },
     {
       "col_id": 199150300,
       "col_type": "date",
       "date": "0001-01-01T00:00:00Z"
     },
     {
       "col_id": 139937550,
       "col_type": "time",
       "time": "1919-04-03T21:05:37.017498068Z"
     },
     {
       "col_id": 35163253,
       "col_type": "address",
       "street_address1": "56235 Club ton",
       "street_address2": "772 Port Valleys stad",
       "city": "Chandler",
       "state": "Nebraska",
       "zip": "58231",
       "country": "Gibraltar"
     },
     {
       "col_id": 22148015,
       "col_type": "multi_choice"
     },
     {
       "col_id": 23015426,
       "col_type": "link",
       "title": "Philippine before throughout wander of as there next of sleep.",
       "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
       "desc": "Cap today am terribly many because anyone does you hungrily."
     },
     {
       "col_id": 166687029,
       "col_type": "image",
       "url": "https://picsum.photos/id/83/200/300",
       "image_name": "Eastern with herself muster monthly it party another his ours."
     },
     {
       "col_id": 172741244,
       "col_type": "html_paragraph",
       "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
     }
   ]
}

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 Member Directory

View Method
Get Members

View Method
Search Member Directory

View Method
Search Members

View Method
Get Subscriptions

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
}

The Member Notice Object

The member notice object.

Response Attributes
id
number

Unique ID of the member_notice object.
object
string

member_notice.
created
date
updated
date
group_id
number
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_locked_topic, member_notice_monthly_reminder, member_notice_pending, member_notice_post_to_sub, member_notice_rejected_message, member_notice_rejected_sub, member_notice_removed_sub, member_notice_sponsorship.
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 Object

{
 "id": 63,
 "object": "member_notice",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 33,
 "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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "member_notice",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "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
number
object
string

message.
created
date
updated
date
user_id
number
group_id
number
topic_id
number
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, without hashtags.
subject_with_tags
string

Subject with any hashtags.
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
is_reply
boolean

If this message is a reply.
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_followers_only, 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
number

If this is a Poll, this is the ID of the Poll object.
attachments
array of Attachment objects

Example Object

{
 "id": 63,
 "object": "message",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "topic_id": 78,
 "body": "",
 "quoted": "",
 "remainder": "",
 "snippet": "",
 "subject": "",
 "subject_with_tags": "",
 "name": "",
 "profile_photo_url": "",
 "is_plain_text": false,
 "msg_num": 24,
 "is_reply": false,
 "has_liked": false,
 "num_likes": 59,
 "is_closed": false,
 "is_moderated": false,
 "reply_to": "group_reply_only_to_sender",
 "can_repost": false,
 "hashtags": [
   {
      "id": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   }
 ],
 "poll_id": 2,
 "attachments": [
   {
    "id": 63,
    "media_type": "",
    "download_url": "",
    "image_thumbnail_url": "",
    "filename": "",
   }
 ],
}

The Message History Object

The message history object.

Response Attributes
object
string

message_history.
month_counts
array of Month Count objects

Array of sets of 12 month_count objects.
tz_offset
number

Timezone offset, in minutes difference to UTC.
Methods That Use This Object
Get Message History

View Method

Example Object

{
 "object": "message_history",
 "month_counts": [
   {
    "object": "month_count",
    "year": 63,
    "month": 33,
    "msgs_sent": 47,
   }
 ],
 "tz_offset": 78,
}

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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_perms": 
   {
      "object": "perms",
      "archives_visible": true,
      "polls_visible": true,
      "members_visible": true,
      "chat_visible": true,
      "calendar_visible": true,
      "files_visible": true,
      "database_visible": true,
      "photos_visible": true,
      "wiki_visible": true,
      "member_directory_visible": true,
      "hashtags_visible": true,
      "guidelines_visible": true,
      "subgroups_visible": true,
      "open_donations_visible": true,
      "sponsor_visible": true,
      "manage_subgroups": true,
      "delete_group": true,
      "download_archives": true,
      "download_entire_group": true,
      "download_members": true,
      "view_activity": true,
      "create_hashtags": true,
      "manage_hashtags": true,
      "manage_integrations": true,
      "manage_group_settings": true,
      "make_moderator": true,
      "manage_member_subscription_options": true,
      "manage_pending_members": true,
      "remove_members": true,
      "ban_members": true,
      "manage_group_billing": true,
      "manage_group_payments": true,
      "edit_archives": true,
      "manage_pending_messages": true,
      "invite_members": true,
      "can_post": true,
      "can_vote": true,
      "manage_polls": true,
      "manage_photos": true,
      "manage_members": true,
      "manage_calendar": true,
      "manage_chats": true,
      "view_member_directory": true,
      "manage_files": true,
      "manage_wiki": true,
      "manage_subscription": true,
      "public_page": true,
      "sub_page": true,
      "mod_page": true
   },
 "group": 
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   },
 "cover_photo_url": "",
 "sub_data": [
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   }
 ],
 "topic": 
   {
      "id": 131773379,
      "object": "topic",
      "created": "2020-09-02T18:27:00-07:00",
      "updated": "2021-01-10T20:19:00-08:00",
      "group_id": 73387781,
      "group_subject_tag": "[actually4]",
      "subject": "Them will addition yearly since in these entirely itself whose.",
      "summary": "Rather theirs additionally line to say.",
      "name": "Ladarius Swaniawski",
      "profile_photo_url": "",
      "num_messages": 27,
      "is_sticky": false,
      "is_moderated": false,
      "is_closed": false,
      "has_attachments": false,
      "reply_to": "thread_reply_group_default",
      "most_recent_message": "1969-12-31T16:00:00-08:00",
      "hashtags": null
   },
 "data": [
   {
    "id": 63,
    "object": "message",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 47,
    "topic_id": 78,
    "body": "",
    "quoted": "",
    "remainder": "",
    "snippet": "",
    "subject": "",
    "subject_with_tags": "",
    "name": "",
    "profile_photo_url": "",
    "is_plain_text": false,
    "msg_num": 24,
    "is_reply": false,
    "has_liked": false,
    "num_likes": 59,
    "is_closed": false,
    "is_moderated": false,
    "reply_to": "group_reply_only_to_sender",
    "can_repost": false,
    "hashtags": [
      {
         "id": 1758,
         "object": "hashtag",
         "created": "2020-09-16T20:58:00-07:00",
         "group_id": 903,
         "name": "Barney Parisian",
         "mods_only_post": true,
         "mods_only_replies": false,
         "no_email": true,
         "moderated": true,
         "special": true,
         "replies_unmoderated": false,
         "locked": true,
         "until": "hashtag_delete_month",
         "close_instead_of_delete": false,
         "description": "Them will addition yearly since in these entirely itself.",
         "color_name": "bluejean",
         "color_hex": "#8ec2ee",
         "reply_to": "thread_reply_to_sender",
         "topic_count": 1162,
         "last_message_date": "2020-09-28T03:08:00-07:00",
         "muted": null,
         "followed": null
      }
    ],
    "poll_id": 2,
    "attachments": [
      {
       "id": 63,
       "media_type": "",
       "download_url": "",
       "image_thumbnail_url": "",
       "filename": "",
      }
    ],
   }
 ],
}

The Message Search Result Object

The message search result object.

Response Attributes
id
number
object
string

message_search_result.
created
date
updated
date
group_id
number
topic_id
number
summary
string

Results summary, in HTML.
subject
string

Subject of the message.
body
string

Plain text body of the message, restricted to the first 500,000 bytes.
user_id
number
profile_photo_url
string

If not empty then there is a profile photo associated with this votor.
name
string

Name of the person who voted.
can_view_profile
boolean

If the person viewing this poll can view the 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 Object

{
 "id": 63,
 "object": "message_search_result",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 33,
 "topic_id": 47,
 "summary": "",
 "subject": "",
 "body": "",
 "user_id": 78,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "rev_count": 24,
 "msg_num": 59,
 "num_msgs_in_topic": 53,
 "is_closed": false,
 "is_moderated": false,
 "is_sticky": false,
 "has_attachments": false,
 "hashtags": [
   {
      "id": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   }
 ],
}

The Message Search Results List Object

Message 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.
profile_photo_url
string

If not empty then there is a profile photo associated with this votor.
name
string

Name of the person who voted.
can_view_profile
boolean

If the person viewing this poll can view the profile.
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
date

Optional start date of the search.
end_date
optional
date

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
number

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.
profile_photo_url
string

If not empty then there is a profile photo associated with this votor.
name
string

Name of the person who voted.
can_view_profile
boolean

If the person viewing this poll can view the profile.
data
array of Message Search Result objects
Methods That Use This Object
Search Archives

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "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": 1758,
      "object": "hashtag",
      "created": "2020-09-16T20:58:00-07:00",
      "group_id": 903,
      "name": "Barney Parisian",
      "mods_only_post": true,
      "mods_only_replies": false,
      "no_email": true,
      "moderated": true,
      "special": true,
      "replies_unmoderated": false,
      "locked": true,
      "until": "hashtag_delete_month",
      "close_instead_of_delete": false,
      "description": "Them will addition yearly since in these entirely itself.",
      "color_name": "bluejean",
      "color_hex": "#8ec2ee",
      "reply_to": "thread_reply_to_sender",
      "topic_count": 1162,
      "last_message_date": "2020-09-28T03:08:00-07:00",
      "muted": null,
      "followed": null
   },
 "poster_user_id": 2,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "data": [
   {
    "id": 63,
    "object": "message_search_result",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "topic_id": 47,
    "summary": "",
    "subject": "",
    "body": "",
    "user_id": 78,
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
    "rev_count": 24,
    "msg_num": 59,
    "num_msgs_in_topic": 53,
    "is_closed": false,
    "is_moderated": false,
    "is_sticky": false,
    "has_attachments": false,
    "hashtags": [
      {
         "id": 1758,
         "object": "hashtag",
         "created": "2020-09-16T20:58:00-07:00",
         "group_id": 903,
         "name": "Barney Parisian",
         "mods_only_post": true,
         "mods_only_replies": false,
         "no_email": true,
         "moderated": true,
         "special": true,
         "replies_unmoderated": false,
         "locked": true,
         "until": "hashtag_delete_month",
         "close_instead_of_delete": false,
         "description": "Them will addition yearly since in these entirely itself.",
         "color_name": "bluejean",
         "color_hex": "#8ec2ee",
         "reply_to": "thread_reply_to_sender",
         "topic_count": 1162,
         "last_message_date": "2020-09-28T03:08:00-07:00",
         "muted": null,
         "followed": null
      }
    ],
   }
 ],
}

The Month Count Object

The month count object.

Response Attributes
object
string

month_count.
year
number

Year.
month
number

Month.
msgs_sent
number

Number of messages sent that month.

Example Object

{
 "object": "month_count",
 "year": 63,
 "month": 33,
 "msgs_sent": 47,
}

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
Apple Login Start

View Method
Google Login Start

View Method

Example Object

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

The Org Object

The org object.

Response Attributes
id
number

Unique ID of the org object.
object
string

org.
created
date

Time object was created.
updated
date

Time object was last updated.
title
string

Title of the organization.
domain
string

Domain of the organization.
parent_group_id
number

ID of the parent group for this org (each org has 1 parent group).
logged_out_wiki_page_id
number

If not 0, the ID of the WikiPage to display for logged out people visiting the domain.
default_timezone
string

For users created in this timezone.
disable_signup
boolean

Don't allow access to any group page at all if not signed in.
disable_plus_one
boolean

Don't treat +1 emails as likes.
ga_code
string

Google Analytics code.
login_page_text
string

Replace the standard text at the bottom of the login page.
no_account_text
string

Text displayed on the send login link page.
sso_provider
string

If this org uses an SSO identity provider. Can be one of: no_sso, sso_auth0, sso_your_membership.
sso_client_id
string

SSO Client ID.
sso_client_secret
string

SSO Client Secret.
sso_domain
string

SSO Domain.
Methods That Use This Object
Get Org

View Method

Example Object

{
   "id": 1,
   "object": "org",
   "created": "1969-12-31T16:00:00-08:00",
   "updated": "1969-12-31T16:00:00-08:00",
   "title": "Groups.io",
   "domain": "groups.io",
   "parent_group_id": 0,
   "logged_out_wiki_page_id": 0,
   "default_timezone": "",
   "disable_signup": false,
   "disable_plus_one": false,
   "ga_code": "",
   "login_page_text": "",
   "no_account_text": "",
   "sso_provider": "no_sso",
   "sso_client_id": "",
   "sso_client_secret": "",
   "sso_domain": ""
}

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 Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc"
}

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
number
object
string

past_member.
created
date

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_banned_domain, added_dir, added_email_integration, added_event, added_facebook_integration, added_file, added_github_integration, added_group_alias, added_group_notice, 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, attachments_deleted_for_space, attempt_sub_banned_member, attempted_banned_domain_owner, attempted_banned_domain_post, attempted_banned_domain_registration, attempted_file_add_with_virus, bad_expired_thread, banned_by_system, banned_member, bounced_user, canceled_event, changed_email, changed_fullname, changed_payer, changed_thread_replyto, changed_thread_subject, changed_username, claimed_pending_member, claimed_pending_message, closed_thread, color_changed, confirmed_account, created_group, created_subgroup, deleted_account, deleted_album, deleted_alias, deleted_attachment, deleted_banned_domain, deleted_chat_message, deleted_dir, deleted_event, deleted_file, deleted_following_repeat_event, deleted_group_alias, deleted_group_notice, 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, delivery_changed_by_moderator, donation_closed, donation_reopened, donation_requested, donation_updated, edited_album, edited_email_integration, edited_extra_data, edited_facebook_integration, edited_github_integration, edited_group, edited_group_notice, edited_hashtag, edited_instagram_integration, edited_message, edited_message_no_send_unused, edited_moderator_note, edited_photo, edited_rss_integration, edited_trello_integration, event_changed_rsvp, event_moved_from_waitlist, event_rsvp_maybe, event_rsvp_no, event_rsvp_yes, expired_hashtag, expired_member, expired_pending_message, exported_group, extra_data_changed_by_moderator, guidelines_sent, invited_member, joined, left, locked_event, member_donated, member_donation_failed, member_sponsored, member_sponsorship_failed, merge_threads, message_to_attendees, 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, monthly_reminder_sent, moved_dir, moved_file, moved_photo, notifications_changed, notifications_changed_by_moderator, paid_invoice, plan_change, post_to_sub, poststatus_changed, prevented_from_joining, 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, reported_file, reported_message, reported_photo, 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, sig_changed, sig_changed_by_moderator, spam_left, split_thread, sticky_thread, stripe_account_connected, stripe_account_disconnected, unbanned_member, unbounced_user, unlocked_event, unmoderated_thread, unsticky_thread, virus_bounced_member, virus_bounced_nonmember, virus_moderated_message.
member_info
Member Info object

Example Object

{
 "id": 63,
 "object": "past_member",
 "created": "2009-11-10T15:00:00-08:00",
 "action": "spamleft",
 "member_info": 
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   },
}

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 Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "past_member",
    "created": "2009-11-10T15:00:00-08:00",
    "action": "spamleft",
    "member_info": 
      {
         "id": 93518468,
         "object": "member_info",
         "created": "2020-09-05T13:57:00-07:00",
         "updated": "2023-02-12T13:06:00-08:00",
         "user_id": 147779411,
         "group_id": 73387781,
         "group_name": "actually4",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_single",
         "message_selection": "message_selection_all",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_unlimited",
         "approved_posts": 0,
         "mod_status": "sub_modstatus_owner",
         "pending_msg_notify": "sub_notify_email_and_app",
         "pending_sub_notify": "sub_notify_email_and_app",
         "sub_notify": "sub_notify_email_and_app",
         "storage_notify": "sub_notify_email_and_app",
         "sub_group_notify": "sub_notify_email_and_app",
         "message_report_notify": "sub_notify_email_and_app",
         "account_notify": "sub_notify_email_and_app",
         "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
         "owner_msg_notify": "sub_ownermsg_notify_subs",
         "chat_notify": "sub_notify_email_and_app",
         "photo_notify": "sub_notify_email_and_app",
         "file_notify": "sub_notify_email_and_app",
         "wiki_notify": "sub_notify_email_and_app",
         "database_notify": "sub_notify_email_and_app",
         "email": "gersonbeahan@jacobi.io",
         "user_status": "user_status_confirmed",
         "user_name": "Dickens6041",
         "timezone": "America/Chicago",
         "full_name": "Lawson Kreiger",
         "about_me": "Today awfully arrive at",
         "location": "Well away onto",
         "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "Growth one album",
         "color": "color_cerulean_blue",
         "cover_photo_url": "",
         "icon_url": "",
         "nice_group_name": "",
         "subs_count": 0,
         "most_recent_message": "0001-01-01T00:00:00Z",
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "extra_member_data": [
           {
             "col_id": 184312747,
             "col_type": "text",
             "text": "Other openly practically why gun it scold far hourly formerly."
           },
           {
             "col_id": 130018632,
             "col_type": "paragraph",
             "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
           },
           {
             "col_id": 158522530,
             "col_type": "checkbox",
             "checked": false
           },
           {
             "col_id": 77272575,
             "col_type": "multiple_choice"
           },
           {
             "col_id": 199150300,
             "col_type": "date",
             "date": "0001-01-01T00:00:00Z"
           },
           {
             "col_id": 139937550,
             "col_type": "time",
             "time": "1919-04-03T21:05:37.017498068Z"
           },
           {
             "col_id": 35163253,
             "col_type": "address",
             "street_address1": "56235 Club ton",
             "street_address2": "772 Port Valleys stad",
             "city": "Chandler",
             "state": "Nebraska",
             "zip": "58231",
             "country": "Gibraltar"
           },
           {
             "col_id": 22148015,
             "col_type": "multi_choice"
           },
           {
             "col_id": 23015426,
             "col_type": "link",
             "title": "Philippine before throughout wander of as there next of sleep.",
             "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
             "desc": "Cap today am terribly many because anyone does you hungrily."
           },
           {
             "col_id": 166687029,
             "col_type": "image",
             "url": "https://picsum.photos/id/83/200/300",
             "image_name": "Eastern with herself muster monthly it party another his ours."
           },
           {
             "col_id": 172741244,
             "col_type": "html_paragraph",
             "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
           }
         ]
      },
   }
 ],
}

The Pending Message Object

The pending message object.

Response Attributes
object
string

pending_message.
id
number

ID of the pending message object, referenced in results.
created
date

Time pending message was received.
updated
date

Time of last update to the pending message.
group_id
number

ID of the group.
user_id
number

ID of the user.
subject
string

Message subject.
is_special
boolean

True if this is a special message.
is_web_post
boolean

If the message was posted from the web.
has_attachments
boolean

True if the message has attachments.
editor_member_id
number

Member ID of the person who edited this message if this is an edit.
raw_message
string

The message body, in HTML format.
message_body
string

Decoded message body.
body_format
string

Message body format.
sender
optional
Profile Data object

Subscriber who sent the message, may be excluded if a non-subscriber.
sender_email
string

Email of the sender, use if sender is not available.
sender_name
string

Name of the sender, use if sender is not available.
claiming_user
optional
Profile Data object

Moderator who has claimed the message.
claimed_date
date

When the moderator claimed the message.
editor
optional
Profile Data object

Moderator who has edited the message, may be excluded if the message hasn't been edited.
edit_reason
string

The reason given by the editor for the edit.
type
string

Pending message type.
virus_name
string

If this message is moderated because of a virus, this is the name of the virus.

Example Object

{
 "object": "pending_message",
 "id": 63,
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "group_id": 33,
 "user_id": 47,
 "subject": "",
 "is_special": false,
 "is_web_post": false,
 "has_attachments": false,
 "editor_member_id": 78,
 "raw_message": "",
 "message_body": "",
 "body_format": "",
 "sender": 
   {
      "profile_photo_url": "",
      "name": "Lawson Kreiger",
      "can_view_profile": false
   },
 "sender_email": "",
 "sender_name": "",
 "claiming_user": 
   {
      "profile_photo_url": "",
      "name": "Lawson Kreiger",
      "can_view_profile": false
   },
 "claimed_date": "2009-11-10T15:00:00-08:00",
 "editor": 
   {
      "profile_photo_url": "",
      "name": "Lawson Kreiger",
      "can_view_profile": false
   },
 "edit_reason": "",
 "type": "",
 "virus_name": "",
}

The Pending Message List Object

Pending 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 Pending Message objects
Methods That Use This Object
Get Pending Messages

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "object": "pending_message",
    "id": 63,
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "group_id": 33,
    "user_id": 47,
    "subject": "",
    "is_special": false,
    "is_web_post": false,
    "has_attachments": false,
    "editor_member_id": 78,
    "raw_message": "",
    "message_body": "",
    "body_format": "",
    "sender": 
      {
         "profile_photo_url": "",
         "name": "Lawson Kreiger",
         "can_view_profile": false
      },
    "sender_email": "",
    "sender_name": "",
    "claiming_user": 
      {
         "profile_photo_url": "",
         "name": "Lawson Kreiger",
         "can_view_profile": false
      },
    "claimed_date": "2009-11-10T15:00:00-08:00",
    "editor": 
      {
         "profile_photo_url": "",
         "name": "Lawson Kreiger",
         "can_view_profile": false
      },
    "edit_reason": "",
    "type": "",
    "virus_name": "",
   }
 ],
}

The Pending Message Result Object

Pending Message Result

Response Attributes
id
number

ID of the pending message.
result
string

Result of the operation on this message.

Example Object

{
 "id": 63,
 "result": "",
}

The Pending Message Results List Object

Pending Message Results List

Response Attributes
data
array of Pending Message Result objects

Example Object

{
 "data": [
   {
    "id": 63,
    "result": "",
   }
 ],
}

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.
archives_visible
boolean

If the group archives are visible.
polls_visible
boolean

If the group polls 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.
sponsor_visible
boolean

If the group sponsor page is visible.
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.
create_hashtags
boolean

Does the user have permission to create hashtags.
manage_hashtags
boolean

Does the user have permission to edit and delete 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.
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.
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.
manage_calendar
boolean

Does the user have permission to add or edit calendar events.
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.
manage_files
boolean

Does the user have permission to upload and edit files and folders.
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
Methods That Use This Object
Get Permissions

View Method

Example Object

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

The Photo Object

The photo object.

Response Attributes
id
number

Unique ID of the photo object.
object
string

photo.
created
date
updated
date
user_id
number
group_id
number
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
number
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
optional
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
optional
string
download_url
optional
string
Methods That Use This Object
Get Photo

View Method

Example Object

{
   "id": 893,
   "object": "photo",
   "created": "2020-09-07T18:08:00-07:00",
   "updated": "2022-09-25T00:35:00-07:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "name": "Theirs additionally line",
   "desc": "To say poorly out according.",
   "media_type": "image/jpg",
   "size": 4060156,
   "attachment_num": 0,
   "width": 0,
   "height": 0,
   "album_id": 131773379,
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "format": "jpeg",
   "focal_length": 0,
   "iso": 0,
   "aperture": 0,
   "shutter_speed": 0,
   "taken": 0,
   "make": "",
   "model": ""
}

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 Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 207,
       "object": "photo",
       "created": "2020-09-07T04:11:00-07:00",
       "updated": "2022-01-31T13:36:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Itself whose rather theirs additionally line",
       "desc": "To say poorly out according abundant.",
       "media_type": "image/jpg",
       "size": 887202,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 131773379,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1729,
       "object": "photo",
       "created": "2020-09-20T08:33:00-07:00",
       "updated": "2021-10-28T06:41:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Soften anyone anyway then to with",
       "desc": "Wild hourly there she it infrequently power tonight.",
       "media_type": "image/jpg",
       "size": 5553891,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 191492111,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 400,
       "object": "photo",
       "created": "2020-09-01T00:15:00-07:00",
       "updated": "2022-02-26T15:50:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "name": "Mine this yesterday",
       "desc": "I smell us courageous some.",
       "media_type": "image/jpg",
       "size": 9963632,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 27198439,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}

The Poll Object

The poll object.

Response Attributes
id
number

Unique ID of the poll object.
object
string

poll.
created
date
updated
date
user_id
number

ID of the person who created the poll.
group_id
number

ID of the group.
profile_photo_url
string

If not empty then there is a profile photo associated with this votor.
name
string

Name of the person who voted.
can_view_profile
boolean

If the person viewing this poll can view the 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 results_at_end).
can_view_results
boolean

If you have permission to view the results.
answers
optional
array of Poll Answer objects

The possible answers.
results
optional
array of Poll Result objects

Results.
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 Object

{
 "id": 63,
 "object": "poll",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
 "question": "",
 "desc": "",
 "multiple": false,
 "results_at_end": false,
 "never_show_results": false,
 "can_view_results": false,
 "answers": [
   {
    "answer": "",
    "selected": false,
   }
 ],
 "results": [
   {
    "answer": "",
    "count": 63,
    "percentage": "",
    "votes": [
      {
       "user_id": 63,
       "email": "",
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
      }
    ],
   }
 ],
 "is_closed": false,
 "msg_num": 33,
 "anonymous": false,
}

The Poll Answer Object

The poll answer object.

Response Attributes
answer
string

Possible answer.
selected
boolean

If we selected this answer.

Example Object

{
 "answer": "",
 "selected": false,
}

The Poll Result Object

The poll result 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.
votes
optional
array of Poll Vote objects

All votes for this answer, if we have permission to view them.

Example Object

{
 "answer": "",
 "count": 63,
 "percentage": "",
 "votes": [
   {
    "user_id": 63,
    "email": "",
    "profile_photo_url": "",
    "name": "",
    "can_view_profile": false,
   }
 ],
}

The Poll Results Object

The poll results object.

Response Attributes
poll_id
number

Unique ID of the poll object.
object
string

poll_results.
results
array of Poll Result objects

Results.
Methods That Use This Object
Get Poll Results

View Method

Example Object

{
 "poll_id": 63,
 "object": "poll_results",
 "results": [
   {
    "answer": "",
    "count": 63,
    "percentage": "",
    "votes": [
      {
       "user_id": 63,
       "email": "",
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
      }
    ],
   }
 ],
}

The Poll Vote Object

The poll vote object. Represents a single vote in a poll.

Response Attributes
user_id
number

User ID of the voter.
email
string

Email of the voter.
profile_photo_url
string

If not empty then there is a profile photo associated with this votor.
name
string

Name of the person who voted.
can_view_profile
boolean

If the person viewing this poll can view the profile.

Example Object

{
 "user_id": 63,
 "email": "",
 "profile_photo_url": "",
 "name": "",
 "can_view_profile": false,
}

The Profile Data Object

The profile data object.

Response Attributes
profile_photo_url
string

If not empty then there is a profile photo associated with this votor.
name
string

Name of the person who voted.
can_view_profile
boolean

If the person viewing this poll can view the profile.

Example Object

{
   "profile_photo_url": "",
   "name": "Lawson Kreiger",
   "can_view_profile": false
}

The Push Sub Object

The push subscription object.

Response Attributes
id
number

Unique ID of the push sub object.
object
string

push_sub.
created
date
updated
date
user_id
number

ID of the person who is subscribed.
type
string

Type of push subscription. Can be one of: mobile_push_sub, no_push_sub, web_push_sub.
os
string

Operating System associated with the push subscription.
browser
string

Browser associated with the push subscription, not set if this is a device push subscription. Can be one of: app, chrome, chromium, crawler, edge, firefox, msie, opera, safari, unknown_browser.
p256dh
string

for web push subs.
auth
string

for web push subs.
endpoint
string

for web push subs, is the token for mobile push subs.

Example Object

{
 "id": 63,
 "object": "push_sub",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "type": "mobile_push_sub",
 "os": "",
 "browser": "app",
 "p256dh": "",
 "auth": "",
 "endpoint": "",
}

The Push Sub List Object

Push Sub 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 Push Sub objects
Methods That Use This Object
Get Push Subs

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "push_sub",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "type": "mobile_push_sub",
    "os": "",
    "browser": "app",
    "p256dh": "",
    "auth": "",
    "endpoint": "",
   }
 ],
}

The RSVP Object

The rsvp object.

Response Attributes
id
number

Unique ID of the rsvp object.
object
string

rsvp.
created
date

The time that this object was created.
updated
date

The time that this object was last updated.
event_id
number

The ID of the associated event object.
group_id
number

The ID of the associated group.
user_id
number

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 Object

{
 "id": 63,
 "object": "rsvp",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "event_id": 33,
 "group_id": 47,
 "user_id": 78,
 "user_name": "",
 "full_name": "",
 "email": "",
 "profile_photo_url": "",
 "type": "rsvp_maybe",
 "comment": "",
 "additional_guests": 24,
}

The Sub Group And Category Object

The sub group and category object.

Response Attributes
category
Sub Group Category object
group
Group object

Example Object

{
 "category": 
   {
    "id": 63,
    "object": "sub_group_category",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "parent_group_id": 33,
    "name": "example",
    "desc": "",
    "max_subs": 47,
    "order": 78,
   },
 "group": 
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   },
}

The Sub Group Category Object

The sub group category object.

Response Attributes
id
number
object
string

sub_group_category.
created
date
updated
date
parent_group_id
number
name
string

Name.
desc
string

Description, in HTML format.
max_subs
number

Max number of subscribers allowed per group.
order
number

Used in sort.

Example Object

{
 "id": 63,
 "object": "sub_group_category",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "parent_group_id": 33,
 "name": "example",
 "desc": "",
 "max_subs": 47,
 "order": 78,
}

The Sub Group Category List Object

Sub Group Category 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 Sub Group Category objects
Methods That Use This Object
Get Sub Group Categories

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "data": [
   {
    "id": 63,
    "object": "sub_group_category",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "parent_group_id": 33,
    "name": "example",
    "desc": "",
    "max_subs": 47,
    "order": 78,
   }
 ],
}

The Sub Groups By Category Object

The sub groups by categories object.

Response Attributes
subscribed
array of Sub Group And Category objects

Subgroups you are subscribed to.
uncategorized
array of Group objects

Uncategorized subgroups you are not subscribed to.
by_category
array of Sub Group And Category objects

Categorized subgroups you are not subscribed to.
Methods That Use This Object
Get Sub Groups By Category

View Method

Example Object

{
 "subscribed": [
   {
    "category": 
      {
       "id": 63,
       "object": "sub_group_category",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "parent_group_id": 33,
       "name": "example",
       "desc": "",
       "max_subs": 47,
       "order": 78,
      },
    "group": 
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      },
   }
 ],
 "uncategorized": [
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   }
 ],
 "by_category": [
   {
    "category": 
      {
       "id": 63,
       "object": "sub_group_category",
       "created": "2009-11-10T15:00:00-08:00",
       "updated": "2009-11-10T15:00:00-08:00",
       "parent_group_id": 33,
       "name": "example",
       "desc": "",
       "max_subs": 47,
       "order": 78,
      },
    "group": 
      {
         "id": 73387781,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "actually4",
         "nice_group_name": "",
         "alias": "",
         "desc": "This is a test group",
         "plain_desc": "This is a test group",
         "subject_tag": "[actually4]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "allow_non_subs_to_post": false,
         "force_html_emails": false,
         "normalize_html_emails": false,
         "reply_to": "group_reply_to_group",
         "remove_other_reply_options": false,
         "privacy": "group_privacy_none",
         "seperate_footers": false,
         "allow_downloads": "allow_downloads_no",
         "members_visible": "group_view_members_moderators",
         "sub_group_access": "sub_group_subs",
         "calendar_access": "group_access_subscribers",
         "files_access": "group_access_subscribers",
         "database_access": "group_access_subscribers",
         "wiki_access": "group_access_subscribers",
         "photos_access": "group_access_subscribers",
         "member_directory_access": "group_access_subscribers",
         "polls_access": "polls_access_subscribers",
         "chat_access": "group_access_subscribers",
         "handle_attachments": "group_attachments_normal",
         "plain_text_only": false,
         "handle_virus": "handle_virus_block",
         "locked": false,
         "plan": "group_plan_premium",
         "trial_group": false,
         "has_cover_photo": false,
         "has_icon": false,
         "parent_group_id": 0,
         "org_id": 1,
         "max_photo_size_email": "max_photo_size_none",
         "max_photo_size_photos": "max_photo_size_none",
         "max_photo_size_databases": "max_photo_size_none",
         "max_photo_size_wiki_images": "max_photo_size_none",
         "hash_tags_required": false,
         "hash_tag_permissions": "hash_tag_create_subs",
         "bounce_attachments": false,
         "allow_photos_in_files": false,
         "allow_reposts": false,
         "min_days_between_reposts": 0,
         "max_number_of_reposts": 0,
         "email_delivery_default": "email_delivery_single",
         "message_selection_default": "message_selection_all",
         "auto_follow_replies_default": false,
         "max_attachment_size_default": "max_attachment_size_small",
         "default_color": "color_cerulean_blue",
         "default_timezone": "America/Los_Angeles",
         "default_time_pref": "standard_time",
         "default_date_pref": "us_date",
         "default_monday_start": false,
         "disable_edits": false,
         "disable_no_email": false,
         "auto_close_threads": false,
         "close_threads_after": 0,
         "auto_moderate_threads": false,
         "moderate_threads_after": 0,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 361,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "1969-12-31T16: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_weekly_friday",
         "send_invites_on_join": false,
         "perms": {
           "object": "perms",
           "archives_visible": true,
           "polls_visible": true,
           "members_visible": true,
           "chat_visible": true,
           "calendar_visible": true,
           "files_visible": true,
           "database_visible": true,
           "photos_visible": true,
           "wiki_visible": true,
           "member_directory_visible": true,
           "hashtags_visible": true,
           "guidelines_visible": true,
           "subgroups_visible": true,
           "open_donations_visible": true,
           "sponsor_visible": true,
           "manage_subgroups": true,
           "delete_group": true,
           "download_archives": true,
           "download_entire_group": true,
           "download_members": true,
           "view_activity": true,
           "create_hashtags": true,
           "manage_hashtags": true,
           "manage_integrations": true,
           "manage_group_settings": true,
           "make_moderator": true,
           "manage_member_subscription_options": true,
           "manage_pending_members": true,
           "remove_members": true,
           "ban_members": true,
           "manage_group_billing": true,
           "manage_group_payments": true,
           "edit_archives": true,
           "manage_pending_messages": true,
           "invite_members": true,
           "can_post": true,
           "can_vote": true,
           "manage_polls": true,
           "manage_photos": true,
           "manage_members": true,
           "manage_calendar": true,
           "manage_chats": true,
           "view_member_directory": true,
           "manage_files": true,
           "manage_wiki": true,
           "manage_subscription": true,
           "public_page": true,
           "sub_page": true,
           "mod_page": true
         },
         "email_address": "actually4@groups.io",
         "extra_member_data_columns": [
           {
             "id": 184312747,
             "name": "Collection dream week that be.",
             "type": "text",
             "required": true,
             "color": "color_mulbery",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "So which archipelago wicked along width whom exaltation himself how."
           },
           {
             "id": 130018632,
             "name": "These execute toast whose have.",
             "type": "paragraph",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Why themselves the huge been we something honesty sing as."
           },
           {
             "id": 158522530,
             "name": "Whom whose heap been regularly.",
             "type": "checkbox",
             "required": true,
             "color": "color_lilac",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Build in this how today nearly carrot are near right."
           },
           {
             "id": 77272575,
             "name": "Onion of how product write.",
             "type": "multiple_choice",
             "required": true,
             "color": "color_cloudy_blue",
             "choices": [
               "Covey range window silence lastly had.",
               "What outcome let while school pause.",
               "Up anxiously today whom itself sleep."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Point week doctor movement whose also it vanish watch these."
           },
           {
             "id": 199150300,
             "name": "Quarterly outfit faithful is often.",
             "type": "date",
             "required": true,
             "color": "color_green_lantern",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Part whom these been hourly then smell then under lastly."
           },
           {
             "id": 139937550,
             "name": "Besides pack when murder her.",
             "type": "time",
             "required": true,
             "color": "color_grape",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Had snore first in limp through first open towards besides."
           },
           {
             "id": 35163253,
             "name": "Black monthly ball upon almost.",
             "type": "address",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
           },
           {
             "id": 22148015,
             "name": "Orchard what far upon which.",
             "type": "multi_choice",
             "required": true,
             "color": "color_orange",
             "choices": [
               "Cheese at kiss rarely each her.",
               "Ski ours host our as did.",
               "They to money such this as."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "These bale nobody few how anyone these string life that."
           },
           {
             "id": 23015426,
             "name": "Regularly nearby twist how time.",
             "type": "link",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Yourselves hungry those right empty none another what full her."
           },
           {
             "id": 166687029,
             "name": "Mob nose his me much.",
             "type": "image",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Bathe whoever afterwards myself mine to his how woman no."
           },
           {
             "id": 172741244,
             "name": "Half am yesterday must why.",
             "type": "html_paragraph",
             "required": true,
             "color": "color_none",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
           }
         ]
      },
   }
 ],
}

The Success Object

The success object.

Response Attributes
object
string

success.
extra
string

Example Object

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

The Topic Object

The topic object.

Response Attributes
id
number
object
string

topic.
created
date
updated
date
group_id
number
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_followers_only, thread_reply_to_group, thread_reply_to_group_and_sender, thread_reply_to_moderators, thread_reply_to_sender.
most_recent_message
date

Date of the most recent message in the topic.
hashtags
array of Hashtag objects

Example Object

{
   "id": 131773379,
   "object": "topic",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "group_id": 73387781,
   "group_subject_tag": "[actually4]",
   "subject": "Them will addition yearly since in these entirely itself whose.",
   "summary": "Rather theirs additionally line to say.",
   "name": "Ladarius Swaniawski",
   "profile_photo_url": "",
   "num_messages": 27,
   "is_sticky": false,
   "is_moderated": false,
   "is_closed": false,
   "has_attachments": false,
   "reply_to": "thread_reply_group_default",
   "most_recent_message": "1969-12-31T16:00:00-08:00",
   "hashtags": null
}

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 Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "topic",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "group_id": 73387781,
       "group_subject_tag": "[actually4]",
       "subject": "Them will addition yearly since in these entirely itself whose.",
       "summary": "Rather theirs additionally line to.",
       "name": "Tyshawn Pfannerstill",
       "profile_photo_url": "",
       "num_messages": 18,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "1969-12-31T16:00:00-08:00",
       "hashtags": null
     },
     {
       "id": 132940728,
       "object": "topic",
       "created": "2020-09-20T08:33:00-07:00",
       "updated": "2021-10-28T06:41:00-07:00",
       "group_id": 73387781,
       "group_subject_tag": "[actually4]",
       "subject": "Had does soften anyone anyway then to with wild hourly.",
       "summary": "There she it infrequently power tonight several its.",
       "name": "Emmett Emard",
       "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": "1969-12-31T16:00:00-08:00",
       "hashtags": null
     },
     {
       "id": 105873107,
       "object": "topic",
       "created": "2020-10-01T07:24:00-07:00",
       "updated": "2020-12-04T03:37:00-08:00",
       "group_id": 73387781,
       "group_subject_tag": "[actually4]",
       "subject": "Poor troop frequently dynasty instance dive now door she exemplified.",
       "summary": "Tomato sedge Himalayan has define bale.",
       "name": "Lulu Schimmel",
       "profile_photo_url": "",
       "num_messages": 14,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "1969-12-31T16:00:00-08:00",
       "hashtags": null
     }
   ]
}

The User Object

The user object.

Response Attributes
id
number
object
string

user.
created
date
updated
date
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
default_calendar_view
string

Default calendar view.
default_hashtag_view
string

Default hashtag view.
default_rsvp_view
string

Default view when viewing rsvps to an event.
home_page
string

Which home page to display. Can be one of: home_page_calendar, home_page_feed, home_page_groups, home_page_topics.
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 Object

{
   "id": 147779411,
   "object": "user",
   "created": "2020-09-01T08:47:00-07:00",
   "updated": "2022-03-01T17:18:00-08:00",
   "email": "gersonbeahan@jacobi.io",
   "full_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "timezone": "America/Chicago",
   "status": "user_status_confirmed",
   "profile_photo_url": "",
   "post_pref": "user_postpref_html",
   "per_page_pref": "user_per_page_pref20",
   "allow_facebook_login": false,
   "allow_google_login": false,
   "allow_sso_login": false,
   "csrf_token": "84491575",
   "two_factor_enabled": false,
   "recovery_codes": "",
   "dont_munge_message_id": false,
   "about_me": "Today awfully arrive at",
   "about_format": "about_html",
   "location": "Well away onto",
   "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
   "time_pref": "standard_time",
   "date_pref": "us_date",
   "monday_start": false,
   "profile_privacy": "profile_private",
   "default_message_view": "thread_view",
   "topics_sort_dir": "sort_none",
   "topic_sort_dir": "sort_none",
   "messages_sort_dir": "sort_none",
   "expanded_messages_sort_dir": "sort_none",
   "search_sort": "relevance_sort",
   "search_sort_dir": "sort_none",
   "photos_order_by": "",
   "photos_sort_dir": "sort_none",
   "album_order_by": "",
   "album_sort_dir": "sort_none",
   "default_calendar_view": "cal_view_month",
   "default_hashtag_view": "view_grid",
   "default_rsvp_view": "view_grid",
   "home_page": "home_page_feed"
}

The Webhook Event Object

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

Response Attributes
id
number

Unique ID for this webhook event.
object
string

Type of object. Is set to webhook_event.
created
date

The time this event happened.
webhook_id
number

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 events on members, this is the member acted upon. May be omitted.
non_member_email
optional
string

For events involving a non-member, this is their email address.
msg_num
optional
number

For events that involve a message, this is the message number.
subject
optional
string

For events that involve a message, this is the subject of the message.
message
optional
string

For events that involve a message, specifically edited_message, sent_message_accepted, sent_message_moderated, this is the raw message.
extra
optional
string

For events that require an extra string.
extra2
optional
string

For events that require a second extra string.
extra_id
optional
number

For events that require an identifier.

Example Object

{
 "id": 63,
 "object": "webhook_event",
 "created": "2009-11-10T15:00:00-08:00",
 "webhook_id": 33,
 "action": "created_group",
 "via": "via_web",
 "group": 
   {
      "id": 73387781,
      "object": "group",
      "created": "2020-09-15T11:29:00-07:00",
      "updated": "2022-02-12T18:51:00-08:00",
      "type": "group_type_messages",
      "title": "",
      "name": "actually4",
      "nice_group_name": "",
      "alias": "",
      "desc": "This is a test group",
      "plain_desc": "This is a test group",
      "subject_tag": "[actually4]",
      "footer": "This is my\nFooter!!!!",
      "website": "",
      "announce": false,
      "moderation": "moderated",
      "new_users_moderated": true,
      "unmoderate_users_after": 3,
      "restricted": true,
      "allow_non_subs_to_post": false,
      "force_html_emails": false,
      "normalize_html_emails": false,
      "reply_to": "group_reply_to_group",
      "remove_other_reply_options": false,
      "privacy": "group_privacy_none",
      "seperate_footers": false,
      "allow_downloads": "allow_downloads_no",
      "members_visible": "group_view_members_moderators",
      "sub_group_access": "sub_group_subs",
      "calendar_access": "group_access_subscribers",
      "files_access": "group_access_subscribers",
      "database_access": "group_access_subscribers",
      "wiki_access": "group_access_subscribers",
      "photos_access": "group_access_subscribers",
      "member_directory_access": "group_access_subscribers",
      "polls_access": "polls_access_subscribers",
      "chat_access": "group_access_subscribers",
      "handle_attachments": "group_attachments_normal",
      "plain_text_only": false,
      "handle_virus": "handle_virus_block",
      "locked": false,
      "plan": "group_plan_premium",
      "trial_group": false,
      "has_cover_photo": false,
      "has_icon": false,
      "parent_group_id": 0,
      "org_id": 1,
      "max_photo_size_email": "max_photo_size_none",
      "max_photo_size_photos": "max_photo_size_none",
      "max_photo_size_databases": "max_photo_size_none",
      "max_photo_size_wiki_images": "max_photo_size_none",
      "hash_tags_required": false,
      "hash_tag_permissions": "hash_tag_create_subs",
      "bounce_attachments": false,
      "allow_photos_in_files": false,
      "allow_reposts": false,
      "min_days_between_reposts": 0,
      "max_number_of_reposts": 0,
      "email_delivery_default": "email_delivery_single",
      "message_selection_default": "message_selection_all",
      "auto_follow_replies_default": false,
      "max_attachment_size_default": "max_attachment_size_small",
      "default_color": "color_cerulean_blue",
      "default_timezone": "America/Los_Angeles",
      "default_time_pref": "standard_time",
      "default_date_pref": "us_date",
      "default_monday_start": false,
      "disable_edits": false,
      "disable_no_email": false,
      "auto_close_threads": false,
      "close_threads_after": 0,
      "auto_moderate_threads": false,
      "moderate_threads_after": 0,
      "sticky_wiki_page_id": 0,
      "sub_group_categoryid": 0,
      "subs_count": 361,
      "pending_subs_count": 0,
      "pending_msgs_count": 0,
      "open_chats_count": 0,
      "threads_count": 0,
      "messages_count": 0,
      "org_domain": "",
      "most_recent_message": "1969-12-31T16: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_weekly_friday",
      "send_invites_on_join": false,
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "email_address": "actually4@groups.io",
      "extra_member_data_columns": [
        {
          "id": 184312747,
          "name": "Collection dream week that be.",
          "type": "text",
          "required": true,
          "color": "color_mulbery",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "So which archipelago wicked along width whom exaltation himself how."
        },
        {
          "id": 130018632,
          "name": "These execute toast whose have.",
          "type": "paragraph",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Why themselves the huge been we something honesty sing as."
        },
        {
          "id": 158522530,
          "name": "Whom whose heap been regularly.",
          "type": "checkbox",
          "required": true,
          "color": "color_lilac",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Build in this how today nearly carrot are near right."
        },
        {
          "id": 77272575,
          "name": "Onion of how product write.",
          "type": "multiple_choice",
          "required": true,
          "color": "color_cloudy_blue",
          "choices": [
            "Covey range window silence lastly had.",
            "What outcome let while school pause.",
            "Up anxiously today whom itself sleep."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Point week doctor movement whose also it vanish watch these."
        },
        {
          "id": 199150300,
          "name": "Quarterly outfit faithful is often.",
          "type": "date",
          "required": true,
          "color": "color_green_lantern",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Part whom these been hourly then smell then under lastly."
        },
        {
          "id": 139937550,
          "name": "Besides pack when murder her.",
          "type": "time",
          "required": true,
          "color": "color_grape",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Had snore first in limp through first open towards besides."
        },
        {
          "id": 35163253,
          "name": "Black monthly ball upon almost.",
          "type": "address",
          "required": true,
          "color": "color_light_grey",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Everything dynasty behalf shall nearly this weekly for anywhere everybody."
        },
        {
          "id": 22148015,
          "name": "Orchard what far upon which.",
          "type": "multi_choice",
          "required": true,
          "color": "color_orange",
          "choices": [
            "Cheese at kiss rarely each her.",
            "Ski ours host our as did.",
            "They to money such this as."
          ],
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "These bale nobody few how anyone these string life that."
        },
        {
          "id": 23015426,
          "name": "Regularly nearby twist how time.",
          "type": "link",
          "required": true,
          "color": "color_emerald_green",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Yourselves hungry those right empty none another what full her."
        },
        {
          "id": 166687029,
          "name": "Mob nose his me much.",
          "type": "image",
          "required": true,
          "color": "color_sage",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Bathe whoever afterwards myself mine to his how woman no."
        },
        {
          "id": 172741244,
          "name": "Half am yesterday must why.",
          "type": "html_paragraph",
          "required": true,
          "color": "color_none",
          "width": 0,
          "default_hidden": false,
          "profile": false,
          "description": "Pretty that nightly limit we kneel herself collect yourselves yourselves."
        }
      ]
   },
 "member_info": 
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   },
 "modded_member_info": 
   {
      "id": 93518468,
      "object": "member_info",
      "created": "2020-09-05T13:57:00-07:00",
      "updated": "2023-02-12T13:06:00-08:00",
      "user_id": 147779411,
      "group_id": 73387781,
      "group_name": "actually4",
      "status": "sub_status_normal",
      "post_status": "sub_poststatus_newusermoderated",
      "email_delivery": "email_delivery_single",
      "message_selection": "message_selection_all",
      "auto_follow_replies": false,
      "max_attachment_size": "max_attachment_size_unlimited",
      "approved_posts": 0,
      "mod_status": "sub_modstatus_owner",
      "pending_msg_notify": "sub_notify_email_and_app",
      "pending_sub_notify": "sub_notify_email_and_app",
      "sub_notify": "sub_notify_email_and_app",
      "storage_notify": "sub_notify_email_and_app",
      "sub_group_notify": "sub_notify_email_and_app",
      "message_report_notify": "sub_notify_email_and_app",
      "account_notify": "sub_notify_email_and_app",
      "mod_permissions": "sub_perm_pendingmsg,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,sub_perm_viewmembers,sub_perm_managepaidsubscriptions",
      "owner_msg_notify": "sub_ownermsg_notify_subs",
      "chat_notify": "sub_notify_email_and_app",
      "photo_notify": "sub_notify_email_and_app",
      "file_notify": "sub_notify_email_and_app",
      "wiki_notify": "sub_notify_email_and_app",
      "database_notify": "sub_notify_email_and_app",
      "email": "gersonbeahan@jacobi.io",
      "user_status": "user_status_confirmed",
      "user_name": "Dickens6041",
      "timezone": "America/Chicago",
      "full_name": "Lawson Kreiger",
      "about_me": "Today awfully arrive at",
      "location": "Well away onto",
      "website": "http://www.centralgenerate.com/scalable/best-of-breed/deliver/content",
      "profile_privacy": "profile_private",
      "dont_munge_message_id": false,
      "use_signature": false,
      "use_signature_email": false,
      "signature": "Growth one album",
      "color": "color_cerulean_blue",
      "cover_photo_url": "",
      "icon_url": "",
      "nice_group_name": "",
      "subs_count": 0,
      "most_recent_message": "0001-01-01T00:00:00Z",
      "perms": {
        "object": "perms",
        "archives_visible": true,
        "polls_visible": true,
        "members_visible": true,
        "chat_visible": true,
        "calendar_visible": true,
        "files_visible": true,
        "database_visible": true,
        "photos_visible": true,
        "wiki_visible": true,
        "member_directory_visible": true,
        "hashtags_visible": true,
        "guidelines_visible": true,
        "subgroups_visible": true,
        "open_donations_visible": true,
        "sponsor_visible": true,
        "manage_subgroups": true,
        "delete_group": true,
        "download_archives": true,
        "download_entire_group": true,
        "download_members": true,
        "view_activity": true,
        "create_hashtags": true,
        "manage_hashtags": true,
        "manage_integrations": true,
        "manage_group_settings": true,
        "make_moderator": true,
        "manage_member_subscription_options": true,
        "manage_pending_members": true,
        "remove_members": true,
        "ban_members": true,
        "manage_group_billing": true,
        "manage_group_payments": true,
        "edit_archives": true,
        "manage_pending_messages": true,
        "invite_members": true,
        "can_post": true,
        "can_vote": true,
        "manage_polls": true,
        "manage_photos": true,
        "manage_members": true,
        "manage_calendar": true,
        "manage_chats": true,
        "view_member_directory": true,
        "manage_files": true,
        "manage_wiki": true,
        "manage_subscription": true,
        "public_page": true,
        "sub_page": true,
        "mod_page": true
      },
      "extra_member_data": [
        {
          "col_id": 184312747,
          "col_type": "text",
          "text": "Other openly practically why gun it scold far hourly formerly."
        },
        {
          "col_id": 130018632,
          "col_type": "paragraph",
          "text": "Myself anything several therefore friendship infancy somebody by scenic consequently."
        },
        {
          "col_id": 158522530,
          "col_type": "checkbox",
          "checked": false
        },
        {
          "col_id": 77272575,
          "col_type": "multiple_choice"
        },
        {
          "col_id": 199150300,
          "col_type": "date",
          "date": "0001-01-01T00:00:00Z"
        },
        {
          "col_id": 139937550,
          "col_type": "time",
          "time": "1919-04-03T21:05:37.017498068Z"
        },
        {
          "col_id": 35163253,
          "col_type": "address",
          "street_address1": "56235 Club ton",
          "street_address2": "772 Port Valleys stad",
          "city": "Chandler",
          "state": "Nebraska",
          "zip": "58231",
          "country": "Gibraltar"
        },
        {
          "col_id": 22148015,
          "col_type": "multi_choice"
        },
        {
          "col_id": 23015426,
          "col_type": "link",
          "title": "Philippine before throughout wander of as there next of sleep.",
          "url": "https://www.humaninnovative.name/platforms/enhance/integrated/value-added",
          "desc": "Cap today am terribly many because anyone does you hungrily."
        },
        {
          "col_id": 166687029,
          "col_type": "image",
          "url": "https://picsum.photos/id/83/200/300",
          "image_name": "Eastern with herself muster monthly it party another his ours."
        },
        {
          "col_id": 172741244,
          "col_type": "html_paragraph",
          "text": "Few guitar bear additionally formerly bathe tolerance those his fight."
        }
      ]
   },
 "non_member_email": "",
 "msg_num": 63,
 "subject": "",
 "message": "",
 "extra": "",
 "extra2": "",
 "extra_id": 33,
}

The Webhook Subscription Object

The webhook subscription object.

Response Attributes
object
string

Type of object. Is set to webhook_subscription.
created
date

The time this subscription was created.
updated
date

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.

Example Object

{
 "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": 63,
 "include_subgroups": false,
 "actions": ["created_subgroup"],
}

The Wiki Data Object

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

Response Attributes
id
number
object
string

wiki_data.
created
date
updated
date
user_id
number
group_id
number
page_id
number
body
string

The body of the wiki page, in HTML format.
edit_msg
string

Optional edit message.

Example Object

{
   "id": 59322191,
   "object": "wiki_data",
   "created": "2020-09-21T08:40:00-07:00",
   "updated": "2023-02-06T00:18:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "page_id": 131773379,
   "body": "Tonight to horror sleep over tea contrast line to say poorly out. According abundant unless nervously string lastly advertising faithfully it later depend deeply. Everybody rhythm for had does soften anyone anyway then to with wild. Hourly there she it infrequently power tonight several its which since tomorrow. Tonight your bag yourself our his which be itself mine this yesterday.\u003cbr/\u003eI smell us courageous some my poor troop frequently dynasty instance dive. Now door she exemplified tomato sedge Himalayan has define bale on this. Library promise us congregation backwards most that leap ream yearly occur her. Nobody are next party little hers hers today case towards herself African. Each our food nearby e.g. understand addition any infrequently idea she from.\u003cbr/\u003eWhich what always in have it eventually city under sleepy shake child. Early garden caused as become lazily wheelchair by her that exaltation homeless. Spoon now its her roll another what climb crew something body then. I fortnightly on must his never research scary band at fire man. Significant British few over before addition pack my whose this secondly that.",
   "edit_msg": "What them myself"
}

The Wiki Page Object

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

Response Attributes
id
number
object
string

wiki_page.
created
date
updated
date
user_id
number
group_id
number
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 Object

{
   "id": 131773379,
   "object": "wiki_page",
   "created": "2020-09-02T18:27:00-07:00",
   "updated": "2021-01-10T20:19:00-08:00",
   "user_id": 147779411,
   "group_id": 73387781,
   "title": "Example will addition yearly since",
   "path": "Example-will-addition-yearly-since",
   "locked": false,
   "rev_count": 22
}

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 Object

{
   "object": "list",
   "total_count": 253,
   "start_item": 47,
   "end_item": 647,
   "has_more": true,
   "next_page_token": 1078,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 131773379,
       "object": "wiki_page",
       "created": "2020-09-04T00:33:00-07:00",
       "updated": "2022-08-12T18:09:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "title": "Example will addition",
       "path": "Example-will-addition",
       "locked": false,
       "rev_count": 47
     },
     {
       "id": 178561260,
       "object": "wiki_page",
       "created": "2020-09-08T11:43:00-07:00",
       "updated": "2022-04-14T04:30:00-07:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "title": "Him those tonight to",
       "path": "Him-those-tonight-to",
       "locked": false,
       "rev_count": 20
     },
     {
       "id": 174116746,
       "object": "wiki_page",
       "created": "2020-09-04T10:02:00-07:00",
       "updated": "2021-12-25T18:43:00-08:00",
       "user_id": 147779411,
       "group_id": 73387781,
       "title": "Itself whose rather theirs additionally",
       "path": "Itself-whose-rather-theirs-additionally",
       "locked": false,
       "rev_count": 45
     }
   ]
}

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
Update Wiki Page

View Method
Get Wiki Page Set

View Method

Example Object

{
   "page": {
     "id": 131773379,
     "object": "wiki_page",
     "created": "2020-09-02T18:27:00-07:00",
     "updated": "2021-01-10T20:19:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "title": "Example will addition yearly since",
     "path": "Example-will-addition-yearly-since",
     "locked": false,
     "rev_count": 22
   },
   "data": {
     "id": 59322191,
     "object": "wiki_data",
     "created": "2020-09-21T08:40:00-07:00",
     "updated": "2023-02-06T00:18:00-08:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Tonight to horror sleep over tea contrast line to say poorly out. According abundant unless nervously string lastly advertising faithfully it later depend deeply. Everybody rhythm for had does soften anyone anyway then to with wild. Hourly there she it infrequently power tonight several its which since tomorrow. Tonight your bag yourself our his which be itself mine this yesterday.\u003cbr/\u003eI smell us courageous some my poor troop frequently dynasty instance dive. Now door she exemplified tomato sedge Himalayan has define bale on this. Library promise us congregation backwards most that leap ream yearly occur her. Nobody are next party little hers hers today case towards herself African. Each our food nearby e.g. understand addition any infrequently idea she from.\u003cbr/\u003eWhich what always in have it eventually city under sleepy shake child. Early garden caused as become lazily wheelchair by her that exaltation homeless. Spoon now its her roll another what climb crew something body then. I fortnightly on must his never research scary band at fire man. Significant British few over before addition pack my whose this secondly that.",
     "edit_msg": "What them myself"
   },
   "sidebar": {
     "id": 19906119,
     "object": "wiki_data",
     "created": "2020-09-02T23:45:00-07:00",
     "updated": "2022-11-02T03:08:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Now conclude yourselves whose since shower quietly each in carry through innocence. What him his why hers they theirs who us who of this. That above youth with fashion tonight her seldom work also anyway what. Quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear usually body. Kilometer nightly child so firstly he next each secondly must catch politely.\u003cbr/\u003eSleepy where i.e. inquisitively yours wisp regularly nice cackle ourselves heavily now. This our yearly what few why where win most would everybody them. Backwards this that provided store elegance joy group Senegalese whichever happen trade. Move outside downstairs of exemplified up out destroy due taste anything where. This that would whom to cautiously till only himself fight our whomever.\u003cbr/\u003eThat for her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look fleet say. Still patrol finally Vietnamese painting otherwise its to a e.g. congregation cackle. Themselves previously in for theirs they my there road disappear accordingly hotel. So today by over have this Romanian abroad around while belong ever.",
     "edit_msg": "Into each whatever fortnightly he"
   },
   "footer": {
     "id": 120133809,
     "object": "wiki_data",
     "created": "2020-09-30T19:43:00-07:00",
     "updated": "2021-11-02T19:38:00-07:00",
     "user_id": 147779411,
     "group_id": 73387781,
     "page_id": 131773379,
     "body": "Here swiftly his fly my one last then sit everyone they had. Mustering would as yesterday we inquire ourselves his laugh string several accordingly. Kindness bit stand woman just poised they enough thing homework each clothing. Other cry obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as out me.\u003cbr/\u003eWere Norwegian significant his do mob notice lastly theirs hotel one calm. That later does point throw neatly usually Kazakh without for one from. Soon swing whose man confusing case Bangladeshi how most somewhat several week. E.g. who earlier gentle catalog ourselves then tonight bend may yearly since. Limit e.g. besides chest their hair out work data sedge this might.\u003cbr/\u003eHow group out then result these preen numerous on frequently him at. Tonight is seriously why kiss logic beyond him swing our Amazonian will. For myself everybody I abundant few weekly anyone an weekly someone being. That her enthusiasm yours never without theirs mine that delay that the. Air whatever bundle you is such batch accommodation without now in yearly.",
     "edit_msg": "Adventurous her for previously as of along"
   }
}

The Wiki Search Result Object

The topic objecsr.

Response Attributes
id
number
object
string

wiki_search_result.
created
date
updated
date
user_id
number
group_id
number
data_id
number
title
string

Title of the page.
rev_count
number

How many times this wiki page has been edited.
body
string

Wiki page body, in HTML.
edit_msg
string

Edit message for this revision, if one.
snippet
string

Matching summary, in HTML.

Example Object

{
 "id": 63,
 "object": "wiki_search_result",
 "created": "2009-11-10T15:00:00-08:00",
 "updated": "2009-11-10T15:00:00-08:00",
 "user_id": 33,
 "group_id": 47,
 "data_id": 78,
 "title": "",
 "rev_count": 24,
 "body": "",
 "edit_msg": "",
 "snippet": "",
}

The Wiki Search Results List Object

Wiki 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
number

ID of the group these results are from.
query
string

The query string.
data
array of Wiki Search Result objects
Methods That Use This Object
Search Wikis

View Method

Example Object

{
 "object": "list",
 "total_count": 63,
 "start_item": 33,
 "end_item": 47,
 "has_more": false,
 "next_page_token": 78,
 "sort_field": "",
 "second_order": "",
 "query": "",
 "sort_dir": "",
 "group_id": 24,
 "query": "",
 "data": [
   {
    "id": 63,
    "object": "wiki_search_result",
    "created": "2009-11-10T15:00:00-08:00",
    "updated": "2009-11-10T15:00:00-08:00",
    "user_id": 33,
    "group_id": 47,
    "data_id": 78,
    "title": "",
    "rev_count": 24,
    "body": "",
    "edit_msg": "",
    "snippet": "",
   }
 ],
}

Types

Types referenced by Objects and Endpoints.

The action type

Possible Values
accepted_invitation
string

Accepted invitation
added_album
string

Added photo album
added_alias
string

Added email alias
added_banned_domain
string

Added banned domain
added_dir
string

Added folder
added_email_integration
string

Added email integration
added_event
string

Added event
added_facebook_integration
string

Added Facebook integration
added_file
string

Added file
added_github_integration
string

Added Github integration
added_group_alias
string

Added group alias
added_group_notice
string

Added member notice
added_hashtag
string

Added hashtag
added_instagram_integration
string

Added Instagram integration
added_member
string

Direct added member
added_photo
string

Added photo
added_repeat_event
string

Added repeating event
added_row
string

Added row
added_rss_integration
string

Added feed integration
added_table
string

Added table
added_trello_integration
string

Added Trello integration
added_wiki_image
string

Added image to wiki
added_wiki_page
string

Added wiki page
applied
string

Applied for membership
approved_member
string

Approved member
approved_pending_message
string

Approved pending message
attachments_deleted_for_space
string

Attachments deleted for space
attempt_sub_banned_member
string

Banned member attempted to subscribe
attempted_banned_domain_owner
string

Message to +owner rejected from banned domain
attempted_banned_domain_post
string

Message rejected from banned domain
attempted_banned_domain_registration
string

Attempt to subscribe from banned domain
attempted_file_add_with_virus
string

Attempted add of a file with a virus
bad_expired_thread
string

Bad expired thread
banned_by_system
string

Banned by system
banned_member
string

Banned member
bounced_user
string

Bounced
canceled_event
string

Canceled event
changed_email
string

Changed email
changed_fullname
string

Changed display name
changed_payer
string

Changed group payer
changed_thread_replyto
string

Changed topic's reply to
changed_thread_subject
string

Changed topic's subject
changed_username
string

Changed user name
claimed_pending_member
string

Claimed pending member
claimed_pending_message
string

Claimed pending message
closed_thread
string

Locked topic
color_changed
string

Changed color
confirmed_account
string

Confirmed account
created_group
string

Created group
created_subgroup
string

Created subgroup
deleted_account
string

Deleted their Groups.io account
deleted_album
string

Deleted photo album
deleted_alias
string

Deleted email alias
deleted_attachment
string

Deleted attachment
deleted_banned_domain
string

Deleted banned domain
deleted_chat_message
string

Deleted chat message
deleted_dir
string

Deleted folder
deleted_event
string

Deleted event
deleted_file
string

Deleted file
deleted_following_repeat_event
string

Deleted following repeating event
deleted_group_alias
string

Deleted group alias
deleted_group_notice
string

Deleted member notice
deleted_message
string

Deleted message
deleted_message_edit
string

Deleted message edit
deleted_pending_message
string

Deleted pending message
deleted_photo
string

Deleted photo
deleted_repeat_event
string

Deleted repeating event
deleted_row
string

Deleted row
deleted_subgroup
string

Deleted subgroup
deleted_table
string

Deleted table
deleted_thread
string

Deleted topic
deleted_wiki_image
string

Deleted image from wiki
deleted_wiki_page
string

Deleted wiki page
deleted_wiki_rev
string

Deleted wiki revision
delivery_changed
string

Changed email delivery method
delivery_changed_by_moderator
string

Moderator changed email delivery method
donation_closed
string

Donation request closed
donation_reopened
string

Donation request reopened
donation_requested
string

Donation requested
donation_updated
string

Donation request updated
edited_album
string

Edited photo album
edited_email_integration
string

Edited email integration
edited_extra_data
string

Edited extra data
edited_facebook_integration
string

Edited Facebook integration
edited_github_integration
string

Edited Github integration
edited_group
string

Edited group
edited_group_notice
string

Edited member notice
edited_hashtag
string

Edited hashtag
edited_instagram_integration
string

Edited Instagram integration
edited_message
string

Edited message
edited_message_no_send_unused
string

Edited message without sending to the group
edited_moderator_note
string

Edited moderator notes
edited_photo
string

Edited photo
edited_rss_integration
string

Edited feed integration
edited_trello_integration
string

Edited Trello integration
event_changed_rsvp
string

Changed RSVP
event_moved_from_waitlist
string

Moved off waitlist
event_rsvp_maybe
string

RSVP not sure
event_rsvp_no
string

RSVP no
event_rsvp_yes
string

RSVP yes
expired_hashtag
string

Expired hashtag
expired_member
string

Expired member
expired_pending_message
string

Expired pending message
exported_group
string

Exported the group
extra_data_changed_by_moderator
string

Moderator changed extra data
guidelines_sent
string

Guidelines Sent
invited_member
string

Invited member
joined
string

Joined
left
string

Left
locked_event
string

Locked event
member_donated
string

Member donated
member_donation_failed
string

Member donated failed
member_sponsored
string

Member sponsored
member_sponsorship_failed
string

Member sponsorship failed
merge_threads
string

Merge topics
message_to_attendees
string

Message to attendees
mod_changed_email
string

Moderator changed member email
mod_changed_fullname
string

Moderator changed display name
moderated_thread
string

Moderated topic
moderator_changed
string

Moderator changed moderator permissions
modified_dir
string

Modified folder
modified_event
string

Modified event
modified_file
string

Modified file
modified_repeat_event
string

Modified repeating event
modified_row
string

Modified row
modified_table
string

Modified table
modified_wiki_page
string

Modified wiki page
monthly_reminder_sent
string

Monthly Reminder Sent
moved_dir
string

Moved folder
moved_file
string

Moved file
moved_photo
string

Moved photo
notifications_changed
string

Changed notifications
notifications_changed_by_moderator
string

Moderator changed notifications
paid_invoice
string

Paid group invoice
plan_change
string

Changed group plan
post_to_sub
string

Message to member
poststatus_changed
string

Changed posting status
prevented_from_joining
string

Prevented from joining
reinvited_member
string

Reinvited member
rejected_member
string

Rejected member
rejected_pending_message
string

Rejected pending message
removed_email_integration
string

Removed email integration
removed_facebook_integration
string

Removed Facebook integration
removed_github_integration
string

Removed Github integration
removed_hashtag
string

Removed hashtag
removed_instagram_integration
string

Removed Instagram integration
removed_invite
string

Removed invitation
removed_member
string

Removed member
removed_rss_integration
string

Removed feed integration
removed_trello_integration
string

Removed Trello integration
reopened_thread
string

Unlocked topic
reported_file
string

Reported file
reported_message
string

Reported message
reported_photo
string

Reported photo
resent_confirmation
string

Resent confirmation email
resent_pending_member_notice
string

Resent pending member notice
resumed_membership
string

Resumed membership
rotated_photo
string

Rotated photo
sent_bounce_probe
string

Sent bounce probe
sent_message_accepted
string

Sent message
sent_message_announcement
string

Message rejected to announcement group
sent_message_announcement_password
string

Message rejected to announcement group because of incorrect password
sent_message_attachment_bounced
string

Message rejected because of attachments
sent_message_banned
string

Message rejected from banned member
sent_message_bounced_sub
string

Message rejected from bouncing member
sent_message_cant_add_event
string

No permission to add a calendar event
sent_message_cant_create_tags
string

Message with a new tag
sent_message_closed_topic
string

Message rejected to locked topic
sent_message_mod_only_tags
string

Message with a tag only moderators can use
sent_message_moderated
string

Sent message requiring approval
sent_message_no_tags
string

Message without any tags
sent_message_not_allowed
string

Message rejected from member who can't post
sent_message_not_confirmed_sub
string

Message rejected from not confirmed member
sent_message_not_subscriber
string

Non-member message
sent_message_pending_sub
string

Message rejected from pending member
sent_message_too_big
string

Message rejected was too big
sent_to_owner
string

Message to +owner
sig_changed
string

Changed signature
sig_changed_by_moderator
string

Moderator changed signature
spam_left
string

Removed because of spam report
split_thread
string

Split topic
sticky_thread
string

Made topic sticky
stripe_account_connected
string

Stripe account connected
stripe_account_disconnected
string

Stripe account disconnected
unbanned_member
string

Unbanned member
unbounced_user
string

Unbounced
unlocked_event
string

Unlocked event
unmoderated_thread
string

Unmoderated topic
unsticky_thread
string

Unstuck topic
virus_bounced_member
string

Message rejected from member because of virus
virus_bounced_nonmember
string

Message rejected from non-member because of virus
virus_moderated_message
string

Message from member required approval because of virus

The delivery_type type

Possible Values
delivery_bounce_probe
string

Bounce probe message
delivery_confirmation
string

Confirmation email
delivery_digest
string

Digest message
delivery_direct_add
string

Direct add message
delivery_invite
string

Invite delivery, not stored
delivery_login_link
string

Login link message
delivery_member_notice
string

Member notice
delivery_mod_notice
string

Moderator notification, type is indicated by MsgID
delivery_reply
string

Reply to sender
delivery_single
string

Single message
delivery_summary
string

Summary message
delivery_to_owner
string

Message sent to a moderator via the +owner address
delivery_to_sub
string

Message to subscriber