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. |
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 |
server |
There was a problem with the server. Please try again later. |
bad_csrf |
The endpoint required a valid |
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.
Pagination
Some API resources support pagination. These calls take at least these query parameters: limit
, page_token
, sort_field
, sort_dir
. Their responses use the list response format
defined below.
Groups.io utilizes cursor-based pagination via the page_token
and next_page_token
parameters. For the first call to an endpoint that supports paging, do
not include the page_token
parameter. The response will include a next_page_token
number. To fetch the next page of results, call the endpoint with
page_token
set to the next_page_token
number.
limit
optional number, 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 |
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'. |
object
string, value is "list" |
String representing the object’s type. Objects of the same type share the same value. |
total_count
number |
The total number of items. |
start_item
number |
The index of the first item returned. |
end_item
number |
The index of the last item returned. |
has_more
boolean |
Whether or not there are more elements available after this set. If |
next_page_token
opaque |
To fetch the next page, set the |
data
array |
An array containing the actual response elements, paginated by any request parameters. |
Example Response
{
"object": "list",
"total_count": 2,
"start_item": 1,
"end_item": 2,
"has_more": false,
"next_page_token": 0,
"data": [
{
"id": 701,
"object": "subscription",
"created": "2017-08-15T13:58:22.618029196-07:00",
"updated": "2017-08-15T13:58:22.618029196-07:00",
"user_id": 147,
"group_id": 4,
"status": "sub_status_normal",
"post_status": "sub_poststatus_normal",
"email_delivery": "email_delivery_single",
"message_selection": "message_selection_all",
"auto_follow_replies": false,
"max_attachment_size": "max_attachment_size_small",
"approved_posts": 0,
"mod_status": "sub_modstatus_none",
"pending_msg_notify": "sub_notify_email",
"pending_sub_notify": "sub_notify_email",
"sub_notify": "sub_notify_email",
"storage_notify": "sub_notify_email",
"sub_group_notify": "sub_notify_email",
"message_report_notify": "sub_notify_email",
"mod_permissions": "",
"owner_msg_notify": "sub_ownermsg_notify_subs",
"email": "john@smith.com",
"user_status": "user_status_confirmed",
"user_name": "",
"timezone": "",
"full_name": "John Smith",
"about_me": "",
"about_format": "about_html",
"location": "",
"website": "",
"profile_photo_id": "",
"profile_privacy": "profile_private",
"dont_munge_message_id": false,
"moderator_notes": "",
"moderator_notes_updated": "1969-12-31T16:00:00-08:00",
"use_signature": false,
"use_signature_email": false
},
{
"id": 702,
"object": "subscription",
"created": "2017-08-15T13:58:22.618029196-07:00",
"updated": "2017-08-15T13:58:22.618029196-07:00",
"user_id": 147,
"group_id": 4,
"status": "sub_status_normal",
"post_status": "sub_poststatus_normal",
"email_delivery": "email_delivery_single",
"message_selection": "message_selection_all",
"auto_follow_replies": false,
"max_attachment_size": "max_attachment_size_small",
"approved_posts": 0,
"mod_status": "sub_modstatus_none",
"pending_msg_notify": "sub_notify_email",
"pending_sub_notify": "sub_notify_email",
"sub_notify": "sub_notify_email",
"storage_notify": "sub_notify_email",
"sub_group_notify": "sub_notify_email",
"message_report_notify": "sub_notify_email",
"mod_permissions": "",
"owner_msg_notify": "sub_ownermsg_notify_subs",
"email": "john@smith.com",
"user_status": "user_status_confirmed",
"user_name": "",
"timezone": "",
"full_name": "John Smith",
"about_me": "",
"about_format": "about_html",
"location": "",
"website": "",
"profile_photo_id": "",
"profile_privacy": "profile_private",
"dont_munge_message_id": false,
"moderator_notes": "",
"moderator_notes_updated": "1969-12-31T16:00:00-08:00",
"use_signature": false,
"use_signature_email": false
}
]
}
Libraries
The following are unofficial libraries.
JAVA |
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 NeededYou must have the view_activity
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Valid values are "id" and "created". |
sort_dir
optional string |
Sort direction. Can be |
filter_by
optional string |
Type of log to filter by, can be: |
restrict_date
optional string |
Time period to restrict results by, can be: |
start_date
optional string |
Start time of the time period specified by |
end_date
optional string |
End time of the time period specified by |
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 |
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"
}
]
}
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 NeededYou must have the archives_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Valid values are dependent on the call. |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
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 ErrorsNo 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
}
]
}
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 NeededYou must have the archives_visible
permission to use this call with a group.
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 |
sort_field
optional string |
The field to sort on. Valid values are dependent on the call. |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
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": "",
}
],
}
],
}
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 NeededYou must have the archives_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Valid values are dependent on the call. |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
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": "",
}
],
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Download Archives
Download Archives Download the archives of a group.
Permissions NeededYou must have the download_archives
permission to use this call.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 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. |
- 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 theuser_id
of the person.
You must have the archives_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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: |
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 |
sort_field
optional string |
The field to sort on. Valid values are |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
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
}
],
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Message History
Get the message history.
Permissions NeededNone.
Query Parameters
group_id
optional number |
ID of the group. If neither |
group_name
optional string |
Name of the group. If neither |
offset
optional number |
Timezone offset, in minutes. |
extended
optional boolean |
If |
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,
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Chats
There are several aspects to the Chat system.
- The Chat object represents a chat.
- Chats can be subscribed to.
New Chat
Create a new chat. The chat is created and the user is subscribed to the chat.
Permissions NeededYou must have the manage_chats
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
subject
required string |
The subject of the chat. |
desc
required string |
The description of the chat, in HTML format. |
announce
required bool |
If |
csrf
required string |
The |
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
}
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Update Chat
Update a chat object.
Permissions NeededYou 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 |
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 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
}
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Chats
Get chats. Chats are returned using the pagination request and object format.
Permissions NeededYou must have the chat_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
show_closed
optional boolean |
If |
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 |
sort_field
optional string |
The field to sort on. Valid values are dependent on the call. |
sort_dir
optional string |
Sort direction. Can be |
Returns a chat list object if successful. Returns an error if there is an error.
Additional ErrorsNo 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
}
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delete Chat
Delete a chat object.
Permissions NeededYou 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 |
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 NeededYou must have the chat_visible
permission to use this call with a group.
chat_id
required number |
ID of the chat to join. |
csrf
required string |
The |
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
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Chat Members
Get a list of the members of the chat.
Permissions NeededYou 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 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."
}
]
}
],
}
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 NeededYou 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 |
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 NeededYou must be subscribed to the group.
GET Parameters
chat_id
required number |
ID of the chat to view. |
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@..."
}
]
}
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 NeededYou must have the database_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Valid values are dependent on the call. |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
Returns a database list object if successful. Returns an error if there is an error.
Additional ErrorsNo 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,
}
],
}
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 NeededYou must have the database_visible
permission to use this call with a group.
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 |
sort_field
optional string |
The field to sort on. Valid values are dependent on the call. |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
Returns a database row list object if successful. Returns an error if there is an error.
Additional ErrorsNo 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,
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delivery
Get Delivery Info
Get a user's group specific delivery information.
Permissions NeededNone if viewing your own delivery information. If viewing another member's delivery information, you need the manage_members
permission.
group_id
optional number |
ID of the group. If neither |
group_name
optional string |
Name of the group. If neither |
member_info_id
optional number |
If specified, return the delivery information for this member. You must have the |
extended
optional boolean |
If |
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",
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Bounce Info
Get a user's bounce information.
Permissions NeededNone.
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 |
sort_field
optional string |
The field to sort on. Valid values are dependent on the call. |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
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",
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Drafts
A draft represent a post as it is being written. The sequence to post a message to a group is as follows:
- Create a new draft with /newdraft.
- Compose the message, periodically saving it with /updatedraft.
- Optionally add attachments, using /addattachments.
- Once complete, sending the draft as a message with /postdraft.
There are also several draft maintenance endpoints.
New Draft
Create a new draft object.
Permissions NeededYou must have the can_post
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
draft_type
required string |
Type of draft. Currently, |
csrf
required string |
The |
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 |
member_id
may be required number |
If this is a |
extended
optional boolean |
If |
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 |
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,
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Update Draft
Update a draft object.
Permissions NeededYou 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 |
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 |
bcc_all
optional boolean |
If all moderators should be BCC'ed when this draft is posted (only applies to |
extended
optional boolean |
If |
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,
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Drafts
Get drafts. Drafts are returned using the pagination request and object format.
Permissions NeededNone
Query Parameters
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Valid values are |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
Returns a draft list object if successful. Returns an error if there is an error.
Additional ErrorsNo 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,
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delete Draft
Delete a draft object.
Permissions NeededYou 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 |
extended
optional boolean |
If |
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 NeededYou 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 |
inline
optional boolean |
If the attachments are inline images. |
extended
optional boolean |
If |
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,
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Attachments
Get attachments.
Permissions NeededYou 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 |
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,
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delete Attachment
Delete an attachment.
Permissions NeededYou 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 |
extended
optional boolean |
If |
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 NeededYou must be the owner of the draft. You must have the can_post
permission in the group.
draft_id
required number |
ID of the draft to post. You must be the owner of the draft. |
csrf
required string |
The |
reply
optional string |
Only applicable if this draft is a reply to a message. Possible values are: |
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 |
extended
optional boolean |
If |
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. |
"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 |
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, thersvp_type
,rsvp_comment
andrsvp_additional_guests
fields represent the previous RSVP response. - If the
rsvp_type
isrsvp_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 ofrsvp_yes
, notrsvp_waitlist
. - On successfully calling the /v1/rsvp endpoint, an
rsvp
object is returned. If thetype
field is set torsvp_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 NeededYou must be subscribed to the group associated with the event.
Query Parameters
event_id
required number |
The ID of the event to return. |
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.
"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,
}
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.
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_name
optional string |
Name of the group. If neither |
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 |
extended
optional boolean |
If |
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,
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
RSVP To An Event
RSVP to an event.
Permissions NeededYou 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: |
additional_guests
required number |
|
comment
required string |
|
csrf
required string |
The |
extended
optional boolean |
If |
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
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 thetype
field of the returned RSVP object. If it isrsvp_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,
}
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 |
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
}
],
}
],
}
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_name
required string |
Name of the group. Either |
extended
optional boolean |
If |
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
}
],
}
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 NeededYou must have permission to add files to the folder.
Query Parameters
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
file_path
optional strings |
If |
notify
optional boolean |
If |
csrf
required string |
The |
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@..."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Add Link
Add file link.
Permissions NeededYou must have permission to add a link to the folder.
Query Parameters
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
link_type
required string |
Type of the link. Can be: |
file_name
required string |
Name of the link. |
url
required string |
The URL. |
parent_folder_id
required number |
ID of the folder to add the link to, or 0 if the top-level. |
desc
optional string |
Description of the link. |
notify
optional boolean |
If |
csrf
required string |
The |
Returns a file object if successful. Returns an error if there is an error.
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/addfilelink
$ curl "https://groups.io/api/v1/addfilelink" \
-b "cookies.curl"
-F link_type=generic \
-F "parent_folder_id=12" \
-F "url=https://example.com" \
-F "file_name=Test" \
-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@..."
}
]
}
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 NeededYou must have the files_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Valid values are: |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
Returns a file list object if successful. Returns an error if there is an error.
Additional ErrorsNo additional errors |
GET /api/v1/getfiledirectory
$ curl "https://groups.io/api/v1/getfiledirectory?group_id=12&path=%2FTop%2FNext" \
-b "cookies.curl"
Example Successful Response
{
"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@..."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get File
Get file.
Permissions NeededYou must have the files_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
path
required string |
Path to file to download. |
extended
optional boolean |
If |
Returns a file object if successful. Returns an error if there is an error.
Additional ErrorsNo additional errors |
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@..."
}
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 NeededYou must have the files_visible
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Valid values are: |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
Returns a file list object if successful. Returns an error if there is an error.
Additional Errors"bad_request" |
"invalid query" is returned if the query string is empty. |
GET /api/v1/searchfiles
$ curl "https://groups.io/api/v1/searchfiles?group_id=12&q=Search+Term" \
-b "cookies.curl"
Example Successful Response
{
"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@..."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delete File
Delete file.
Permissions NeededYou must have permission to edit a file.
Query Parameters
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
file_id
required number |
ID of the file to delete. |
notify
optional boolean |
If |
csrf
required string |
The |
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@..."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Group
Create Group
Create a group.
Permissions NeededNone.
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 |
csrf
required string |
The |
email_delivery
optional string |
Email delivery, can be |
message_selection
optional string |
Message selection, can be |
auto_follow_replies
optional boolean |
|
max_attachment_size
optional string |
Maximum attachment size, can be |
extended
optional boolean |
If |
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. |
- A subscription is created for the user to the group with owner permissions. If
email_delivery
,message_selection
,auto_follow_replies
, ormax_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."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Create Sub Group
Create a subgroup.
Permissions NeededYou must have the manage_subgroups
permission to use this call.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
csrf
required string |
The |
email_delivery
optional string |
Email delivery, can be |
message_selection
optional string |
Message selection, can be |
auto_follow_replies
optional boolean |
|
max_attachment_size
optional string |
Maximum attachment size, can be |
extended
optional boolean |
If |
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 |
"bad_request" |
"group does not support subgroups" is returned if the group is a free group. |
- A subscription is created for the user to the group with owner permissions. If
email_delivery
,message_selection
,auto_follow_replies
, ormax_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."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Group Settings
Get the group settings
Permissions NeededNo 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.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
extended
optional boolean |
If |
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."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Sub Groups
Get a group's subgroups.
Permissions NeededYou must have the manage_group_settings
permission to use this call.
group_id
required number |
ID of the parent group. Either |
group_name
required string |
Name of the parent group. Either |
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 |
sort_field
optional string |
The field to sort on. Can be |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
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."
}
]
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Update Group
Update a group's settings.
Permissions NeededYou must have the manage_group_settings
permission to use this call.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
csrf
required string |
The |
title
optional string |
Title. |
name
optional string |
New name for the group. If this is a subgroup, this needs to be of the form |
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 |
remove_other_reply_options
optional boolean |
|
privacy
optional string |
For a parent/stand alone group, can be For a subgroup, can be |
members_visible
optional string |
Can be |
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: |
calendar_access
optional string |
Can be |
files_access
optional string |
Can be |
database_access
optional string |
Can be |
wiki_access
optional string |
Can be |
photos_access
optional string |
Can be |
member_directory_access
optional string |
Can be |
polls_access
optional string |
Can be |
chat_access
optional string |
Can be |
handle_attachments
optional string |
Can be |
handle_virus
optional string |
Can be: |
plain_text_only
optional boolean |
|
fig_leaf
optional string |
Can be |
max_photo_size_email
optional string |
Can be |
max_photo_size_photos
optional string |
Can be |
max_photo_size_databases
optional string |
Can be |
max_photo_size_wiki_images
optional string |
Can be |
hash_tags_required
optional boolean |
|
hash_tag_permissions
optional string |
Can be: |
bounce_attachments
optional boolean |
|
allow_photos_in_files
optional boolean |
|
email_delivery_default
optional string |
Email delivery default, can be |
message_selection_default
optional string |
Message selection, can be |
auto_follow_replies_default
optional boolean |
|
max_attachment_size_default
optional string |
Maximum attachment size, can be |
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 |
event_summary_schedule
optional string |
Can be |
send_invites_on_join
optional boolean |
If |
lock_group
optional boolean |
If |
extended
optional boolean |
If |
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 Errorsbad_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. |
- A stand alone/parent group cannot have all the fields
announce
,restricted
,moderated
, andnew_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 toemail_delivery_none
will automatically be changed toemail_delivery_special
. Also ifemail_delivery_default
is set toemail_delivery_none
, it will be changed toemail_delivery_special
. - If
force_html_emails
is changed to true, any member subscriptions that were set toemail_delivery_digest
will automatically be changed toemail_delivery_html_digest
. Also ifemail_delivery_default
is set toemail_delivery_digest
, it will be changed toemail_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 ofgroup_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."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delete Group
Delete a group or a subgroup.
Permissions NeededYou must have the delete_group
permission to use this call.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
understand
required string |
The string "I understand". |
csrf
required string |
The |
reason
optional string |
A reason for deleting the group. |
extended
optional boolean |
If |
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. |
- 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 NeededNone.
Query Parameters
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
extended
optional boolean |
If |
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
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Get Group Aliases
Get a group's aliases.
Permissions NeededYou must have the manage_group_settings
permission to use this call.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
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 |
sort_field
optional string |
The field to sort on. Can be |
sort_dir
optional string |
Sort direction. Can be |
extended
optional boolean |
If |
- 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,
}
],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Add New Group Alias
Add a new group alias.
Permissions NeededYou 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.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
alias_name
required string |
Name of the alias to create. |
csrf
required string |
The |
extended
optional boolean |
If |
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 Errorsbad_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. |
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."
}
]
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delete Group Alias
Delete a group alias.
Permissions NeededYou must have the manage_group_settings
permission to use this call.
alias_group_id
required numer |
ID of the alias group object to delete. Either |
alias_group_name
required string |
Name of the alias group object to delete. Either |
csrf
required string |
The |
extended
optional boolean |
If |
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 Errorsbad_request |
"invalid alias_group_name" is returned if the alias name is not a valid alias. |
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."
}
]
}
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 |
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",
}
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 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.
ReturnsReturns 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": ""
}
Send Login Link
Send a login link
Permissions NeededNone.
POST Parameters
email
required string |
The email address to send a login link. |
redir
optional string |
URL to send the user to after they click on the login link. |
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" |
"invalid email" is returned if the email address is missing or invalid. |
"bad_request" |
"inactive user" is returned if the user account has been deactivated. |
POST /api/v1/sendloginlink
$ curl "https://groups.io/api/v1/sendloginlink" \
-b "cookies.curl" \
-d email=test@example.com
Successful Response
HTTP 200
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Authenticate Login Link
Authenticate a login link
Permissions NeededNone.
POST Parameters
cookie
required number |
The number from the login link. |
twofactor
optional number |
If the user account is configured to require two factor authentication, the second factor from an Authenticator app. |
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.
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/authenticateloginlink
$ curl "https://groups.io/api/v1/authenticateloginlink" \
-b "cookies.curl" \
-d cookie=12345678
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",
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Facebook Login Start
Start the Facebook login process.
ReturnsReturns 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"],
}
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 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",
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Apple Login Start
Start the Apple login process.
ReturnsReturns 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"],
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Google Login Start
Start the Google login process.
ReturnsReturns 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"],
}
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 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",
}
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 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",
}
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 NeededYou must have the manage_group_settings
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
csrf
required string |
The |
name
required string |
Name of this member notice |
type
required string |
Type of member notice, can be: |
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 |
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 |
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": "",
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Update Member Notice
Update a member notice object.
Permissions NeededYou must have the manage_group_settings
permission to use this call with a group.
member_notice_id
required number |
ID of the member notice to update. |
csrf
required string |
The |
name
optional string |
Name of this member notice |
type
optional string |
Type of member notice, can be: |
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 |
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 |
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": "",
}
Example Error Response
{
"object": "error",
"type": "inadequate_permissions",
"extra": ""
}
Delete Member Notice
Delete a member notice object.
Permissions NeededYou must have the manage_group_settings
permission to use this call with a group.
member_notice_id
required number |
ID of the member notice to delete. |
csrf
required string |
The |
extended
optional boolean |
If |
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 NeededYou must have the manage_group_settings
permission to use this call with a group.
group_id
required number |
ID of the group. Either |
group_name
required string |
Name of the group. Either |
type
optional string |
Type of member notice to return, can be: |
limit |