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.

AI agents can use the Groups.io API skill guide for authentication, pagination, safety, and endpoint usage guidance.

API Endpoints

Use https://groups.io as the default origin and /api/v1/ as the API path prefix. For example, GET https://groups.io/api/v1/getsubs lists your subscriptions. To scope requests to an enterprise site, use its domain as the origin. This page, /api, is the reference documentation.

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.

Most API errors return HTTP 400 with an error object. HTTP 429 responses have no error object; unknown endpoints return HTTP 404 with a plain-text body. Check the HTTP status before decoding the response. Errors specific to API calls are listed with each API call. General errors, that can happen with any API call, are listed in this section.

Response Attributes

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

General Errors

unauthorized_error	Incorrect email address or password, or a missing or invalid authentication token or cookie.
bad_request	Incorrect parameters passed in. The `extra` field, when set, describes the parameter or condition at fault, for example `invalid poll_id` or `missing member_info_id`.
expired_error	The supplied authentication token is too old.
inadequate_permissions	You do not have permission to execute the specific API call. The `extra` field, when set, names the missing permission or the restriction that applies.
invalid_value	When a value is unrecognized. The `extra` field will be set to the name of the field with the invalid value.
no_group_specified	Neither `group_id` nor `group_name` was specified on an endpoint that requires a group.
group_not_found	The specified `group_id` or `group_name` does not match an existing group.
server	There was a problem with the server. Please try again later.
bad_csrf	The endpoint required a valid `csrf` parameter. The parameter was either missing or incorrect.

HTTP status code summary

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

Example Error Response

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

Extended Return Information#

Many endpoints support extended=true. Normally, an endpoint returns the documented JSON object or an empty body. With extended=true, the response is an array: [user, result], with the User Object first and the endpoint result second. If the endpoint has no result, the array contains only the user: [user].

Pagination#

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

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

Query Parameters

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

List Response Format

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

Example Response

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

Libraries#

The following are unofficial libraries.

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

Authentication

Authentication Methods#

Authentication to the API is performed via one of three methods:

API Keys (Recommended)

The recommended method is to use API keys with the Authorization header, similar to Stripe and OpenAI:

curl "https://groups.io/api/v1/getsubs" \
  -H "Authorization: Bearer YOUR_API_KEY_HERE"

API keys can be created and managed in your account settings at https://groups.io/settings/apikeys. API keys:

Do not require calling /login first
Are stateless - each request is authenticated independently
Bypass two-factor authentication requirements
Do not require CSRF tokens
Can be revoked without changing your password

Apple login is currently unavailable.

Session-Based Authentication

Alternatively, authentication can be performed via 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. The Facebook and Google login flows set authentication cookies. Interactive chat connections require cookie authentication. Generated examples for authenticated HTTP endpoints use Bearer API keys.

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

Request Encoding And Responses#

Send GET parameters in the query string. Send POST parameters as application/x-www-form-urlencoded, except file uploads, which use multipart/form-data. JSON request bodies are not supported unless an endpoint explicitly says otherwise. An Accept: application/json header does not make the request body JSON.

Pass raw values to a URL or form encoder. Do not encode them beforehand. For cURL use --data-urlencode (with --get for GET requests). For multipart uploads use --form for files and --form-string for text fields.

For parameters marked multiple, repeat the same field name: answer=Yes&answer=No. Do not append [] or numeric indexes to the name. In Go use url.Values.Add; in JavaScript use URLSearchParams.append or FormData.append.

Parameters marked conditional explain when they are required. For group identifiers, provide one of group_id or group_name unless the endpoint explicitly allows both to be omitted. Send booleans as true or false. Check the update endpoint's omission rules before leaving out fields; event updates, in particular, replace settings rather than preserving omitted values.

Check the HTTP status before decoding a response. Successful responses may be JSON, an empty body, or a ZIP download, as specified by the endpoint. Handle HTTP 429 with exponential backoff. Do not automatically retry a write whose outcome is unknown.

Cookie and token login

API keys do not require login or a CSRF parameter. To use cookies instead, save the cookies returned by POST /api/v1/login and send them on subsequent calls. Cookie-authenticated writes also require the login response's user.csrf_token, sent as the csrf form parameter.

curl 'https://groups.io/api/v1/login' --cookie-jar cookies.txt \
  --data-urlencode 'email=you@example.com' \
  --data-urlencode 'password=YOUR_PASSWORD'
curl 'https://groups.io/api/v1/getsubs' --cookie cookies.txt

For HTTP Basic authentication, call /api/v1/login with token=true, then use the returned token as the Basic username with an empty password (curl --user 'TOKEN:'). This authentication method does not require csrf.

Activity Log

Get Activity Log#

GET /api/v1/getactivitylog

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are "id" and "created".
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
filter_by optional string	Type of log to filter by, can be: `member`, `message`, `mod`, `pay`.
restrict_date optional string	Time period to restrict results by, can be: `last_24_hours`, `last_week`, `last_30_days`, `before`, `after`, `between`.
start_date optional string	Start time of the time period specified by `restrict_date` values of `after`, `between`.
end_date optional string	End time of the time period specified by `restrict_date` values of `before`, `between`.
action optional string	Restrict results to a single activity type.
member_info_id optional integer	Restrict results to the member.
past_member_info_id optional integer	Restrict results to the past member.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid filter_by" is returned if the filter_by value is invalid.
"bad_request"	"invalid restrict_date" is returned if the restrict_date value is invalid.
"bad_request"	"invalid action" is returned if the action value is invalid.
"bad_request"	"invalid start_date" is returned if the start_date value is invalid.
"bad_request"	"invalid end_date" is returned if the end_date value is invalid.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getactivitylog

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getactivitylog' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getactivitylog"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getactivitylog");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "activity_log",
       "created": "2020-09-02T00:51:00-07:00",
       "group_id": 8658933,
       "entry": "Integration \"testintegration\" sent  special notice #0",
       "via": "via_robot"
     },
     {
       "id": 10192753,
       "object": "activity_log",
       "created": "2020-08-30T23:30:00-07:00",
       "group_id": 8658933,
       "entry": "Integration \"testintegration\" sent  special notice #1",
       "via": "via_robot"
     },
     {
       "id": 122478329,
       "object": "activity_log",
       "created": "2020-10-01T15:33:00-07:00",
       "group_id": 8658933,
       "entry": "Integration \"testintegration\" sent  special notice #2",
       "via": "via_robot"
     }
   ]
}

View Activity Log List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid filter_by"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid restrict_date"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid action"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid start_date"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid end_date"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

group_id optional integer	ID of the group. Either `group_id` or `group_name` can be specified. If neither is specified, a user's set of groups is used.
group_name optional string	Name of the group. Either `group_id` or `group_name` can be specified. If neither is specified, a user's set of groups is used.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	Use `recentpostdate/sticky` when a group is specified, or `recentpostdate` for topics across your groups. Topics are sorted by most recent message; group results also prioritize sticky topics.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

topic_id required integer	ID of the topic to return.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are `Created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

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

"bad_request"	"invalid msg_num" is returned if the message number is missing or invalid, or if the message is not found.

topic_id required integer	ID of the topic.

	A `not_found` error is returned if no summary has been generated for the topic.

topic_id required integer	ID of the topic to update.
subject optional string	The subject of the topic. The subject may include trailing hashtags.
is_moderated optional boolean	If `true`, new posts to the topic require approval.
is_closed optional boolean	If `true`, the topic is locked and cannot be posted to.
is_sticky optional boolean	If `true`, the topic always appears at the top of the group archives.
reply_to optional string	How replies to messages in this topic are handled. Can be one of: `thread_reply_group_default`, `thread_reply_to_group`, `thread_reply_to_sender`, `thread_reply_to_moderators`, `thread_reply_to_group_and_sender`, `thread_reply_only_to_sender`, `thread_reply_to_followers_only`.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

"bad_request"	"invalid topic_id" is returned if the topic id is missing, invalid, or does not exist.
"bad_request"	"invalid subject" is returned if the subject is empty.
"bad_request"	"invalid reply_to" is returned if the reply_to value is invalid.

"bad_request"	"invalid start_time format" is returned if the start_time parameter is not formatted correctly.

topic_id required integer	ID of the topic.

	A `not_subscribed` error is returned if you are not a member of the group.
If generation is not allowed, the error type is the reason	`plan`, `group_opted_out`, `not_member`, `min_messages`, `cooldown`, or `monthly_quota`.

topic_id required integer	ID of the topic.

	A `not_subscribed` error is returned if you are not a member of the group.

Chats

There are several aspects to the Chat system.

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

New Chat#

POST /api/v1/newchat

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

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

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
subject required string	The subject of the chat.
desc required string	The description of the chat, in HTML format.
announce required bool	If `true`, send an announcement of the chat to the group.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newchat

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newchat' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'subject=Test' \
  --data-urlencode 'desc=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("subject", "Test")
    params.Add("desc", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newchat", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newchat");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("subject", "Test");
    body.append("desc", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 52691321,
   "object": "chat",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "profile_photo_url": "",
   "name": "",
   "can_view_profile": false,
   "group_id": 8658933,
   "subject": "Including.",
   "desc": "Tribe anything from.",
   "is_closed": false,
   "num_messages": 21,
   "chat_sub": {
     "id": 179889653,
     "object": "chat_sub",
     "created": "2020-09-10T11:42:00-07:00",
     "updated": "2023-03-29T23:48:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "chat_id": 52691321,
     "last_msg_seen": 40
   }
}

View Chat definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid subject"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid desc"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Chat#

POST /api/v1/updatechat

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be the owner of the chat.

Update a chat object.

POST Parameters

chat_id required integer	ID of the chat to update. You must be the owner of the chat.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
subject optional string	The subject of the chat.
desc optional string	The description of the chat, in HTML format.
is_closed optional boolean	If the chat is closed.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatechat

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatechat' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'chat_id=12' \
  --data-urlencode 'subject=Test' \
  --data-urlencode 'desc=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("chat_id", "12")
    params.Add("subject", "Test")
    params.Add("desc", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatechat", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatechat");
    const body = new URLSearchParams();
    body.append("chat_id", "12");
    body.append("subject", "Test");
    body.append("desc", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 52691321,
   "object": "chat",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "profile_photo_url": "",
   "name": "",
   "can_view_profile": false,
   "group_id": 8658933,
   "subject": "Including.",
   "desc": "Tribe anything from.",
   "is_closed": false,
   "num_messages": 21,
   "chat_sub": {
     "id": 179889653,
     "object": "chat_sub",
     "created": "2020-09-10T11:42:00-07:00",
     "updated": "2023-03-29T23:48:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "chat_id": 52691321,
     "last_msg_seen": 40
   }
}

View Chat definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid chat_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Chats#

GET /api/v1/getchats

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getchats

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getchats' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getchats"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getchats");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "chat",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Including.",
       "desc": "Tribe anything from.",
       "is_closed": false,
       "num_messages": 21,
       "chat_sub": {
         "id": 179889653,
         "object": "chat_sub",
         "created": "2020-09-29T17:03:00-07:00",
         "updated": "2022-06-18T23:30:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 52691321,
         "last_msg_seen": 40
       }
     },
     {
       "id": 195168922,
       "object": "chat",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Pyramid.",
       "desc": "Accordingly onto moreover.",
       "is_closed": false,
       "num_messages": 81,
       "chat_sub": {
         "id": 83034458,
         "object": "chat_sub",
         "created": "2020-09-06T02:40:00-07:00",
         "updated": "2020-10-07T01:03:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 195168922,
         "last_msg_seen": 90
       }
     },
     {
       "id": 182971401,
       "object": "chat",
       "created": "2020-09-24T00:10:00-07:00",
       "updated": "2021-05-19T19:29:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Fear.",
       "desc": "Usually body kilometer.",
       "is_closed": false,
       "num_messages": 198,
       "chat_sub": {
         "id": 122478329,
         "object": "chat_sub",
         "created": "2020-08-30T21:35:00-07:00",
         "updated": "2023-05-02T01:56:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 182971401,
         "last_msg_seen": 84
       }
     }
   ]
}

View Chat List definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Chat#

POST /api/v1/deletechat

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be the owner of the chat.

Delete a chat object.

POST Parameters

chat_id required integer	ID of the chat to delete. You must be the owner of the chat.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletechat

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletechat' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'chat_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("chat_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletechat", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletechat");
    const body = new URLSearchParams();
    body.append("chat_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid chat_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Join Chat#

POST /api/v1/joinchat

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Join a chat.

POST Parameters

chat_id required integer	ID of the chat to join.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/joinchat

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/joinchat' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'chat_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("chat_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/joinchat", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/joinchat");
    const body = new URLSearchParams();
    body.append("chat_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 179889653,
   "object": "chat_sub",
   "created": "2020-09-10T11:42:00-07:00",
   "updated": "2023-03-29T23:48:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "chat_id": 52691321,
   "last_msg_seen": 40
}

View Chat Sub definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid chat_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "closed chat"
}

"closed chat" is returned if the chat has been closed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "already subscribed"
}

"already subscribed" is returned if the user is already subscribed to the chat.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Chat Members#

POST /api/v1/chatmembers

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be subscribed to the chat.

Get a list of the members of the chat.

POST Parameters

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

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/chatmembers

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/chatmembers' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'chatsub_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("chatsub_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/chatmembers", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/chatmembers");
    const body = new URLSearchParams();
    body.append("chatsub_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "end_item": 9,
   "has_more": false,
   "next_page_token": 23,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 48,
   "total_count": 39
}

View Member Info List definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid chatsub_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "closed chat"
}

"closed chat" is returned if the chat has been closed.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Leave Chat#

POST /api/v1/leavechat

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be subscribed to the 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.

POST Parameters

chatsub_id required integer	ID of the chatsub to delete. You must be the owner of the chatsub.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/leavechat

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/leavechat' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'chatsub_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("chatsub_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/leavechat", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/leavechat");
    const body = new URLSearchParams();
    body.append("chatsub_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid chatsub_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Chat History#

GET /api/v1/getchathistory

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must be subscribed to the group.

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

GET Parameters

chat_id required integer	ID of the chat to view.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getchathistory

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getchathistory' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getchathistory"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getchathistory");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 179889653,
       "object": "chat_message",
       "created": "2020-09-29T17:03:00-07:00",
       "version": 5,
       "user_id": 147779411,
       "group_id": 8658933,
       "chat_id": 52691321,
       "type": "chat_msg_type_normal",
       "message": "Market pyramid..",
       "msg_num": 179889653,
       "delete_msg_num": 0,
       "media": null,
       "tapbacks": [
         {
           "user_id": 51506187,
           "sub_id": 14243141,
           "type": "chat_msg_tapback_thumbs_up"
         },
         {
           "user_id": 97752942,
           "sub_id": 10287162,
           "type": "chat_msg_tapback_laugh"
         }
       ],
       "tapback_counts": [
         {
           "type": "chat_msg_tapback_heart",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_thumbs_up",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_thumbs_down",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_laugh",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_exclamation",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_question",
           "count": 0
         }
       ],
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://picsum.photos/id/53/498/325",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 154675724,
       "object": "chat_message",
       "created": "2020-09-14T23:24:00-07:00",
       "version": 5,
       "user_id": 147779411,
       "group_id": 8658933,
       "chat_id": 10192753,
       "type": "chat_msg_type_normal",
       "message": "Lebanese Guyanese you herself greatly one being nest. When itself yet unless outfit were anybody these.",
       "msg_num": 154675724,
       "delete_msg_num": 0,
       "media": null,
       "tapbacks": [
         {
           "user_id": 196646336,
           "sub_id": 144338940,
           "type": "chat_msg_tapback_question"
         },
         {
           "user_id": 123317449,
           "sub_id": 174167102,
           "type": "chat_msg_tapback_heart"
         },
         {
           "user_id": 115712626,
           "sub_id": 20535086,
           "type": "chat_msg_tapback_thumbs_down"
         },
         {
           "user_id": 92539812,
           "sub_id": 54982055,
           "type": "chat_msg_tapback_thumbs_down"
         },
         {
           "user_id": 110808615,
           "sub_id": 161817060,
           "type": "chat_msg_tapback_laugh"
         },
         {
           "user_id": 89933098,
           "sub_id": 19594331,
           "type": "chat_msg_tapback_heart"
         }
       ],
       "tapback_counts": [
         {
           "type": "chat_msg_tapback_heart",
           "count": 2
         },
         {
           "type": "chat_msg_tapback_thumbs_up",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_thumbs_down",
           "count": 2
         },
         {
           "type": "chat_msg_tapback_laugh",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_exclamation",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_question",
           "count": 1
         }
       ],
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://picsum.photos/id/53/498/325",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "chat_message",
       "created": "2020-09-20T09:51:00-07:00",
       "version": 5,
       "user_id": 147779411,
       "group_id": 8658933,
       "chat_id": 137070462,
       "type": "chat_msg_type_normal",
       "message": "What few why where win most would everybody them backwards this that. Provided store elegance joy group Senegalese whichever happen trade move outside downstairs. Of exemplified up out destroy due taste anything where this that would. Whom to cautiously till only himself fight our whomever that for her. Our much nevertheless which numerous alone bevy as by from e.g. otherwise. Laptop cloud then them yourselves few look fleet say still patrol finally. Vietnamese painting otherwise its to a e.g. congregation cackle themselves previously in. For theirs they my there road disappear accordingly hotel so today by. Over have this Romanian abroad around while belong ever into each whatever.",
       "msg_num": 189377967,
       "delete_msg_num": 0,
       "media": null,
       "tapbacks": [
         {
           "user_id": 91729622,
           "sub_id": 141481456,
           "type": "chat_msg_tapback_laugh"
         },
         {
           "user_id": 55138761,
           "sub_id": 139522588,
           "type": "chat_msg_tapback_thumbs_up"
         }
       ],
       "tapback_counts": [
         {
           "type": "chat_msg_tapback_heart",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_thumbs_up",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_thumbs_down",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_laugh",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_exclamation",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_question",
           "count": 0
         }
       ],
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://picsum.photos/id/53/498/325",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     }
   ]
}

View Chat Message List definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid chat_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Databases

Get Databases#

GET /api/v1/getdatabases

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are `created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getdatabases

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getdatabases' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getdatabases"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getdatabases");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "add_rows": "database_access_all",
       "columns": [
         {
           "id": 52691321,
           "name": "Multiple Choice: Including tribe anything from whose.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Next each secondly must catch politely.",
             "Sleepy where i.e. inquisitively yours wisp.",
             "Regularly nice cackle ourselves heavily now."
           ],
           "width": 0,
           "default_hidden": false,
           "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
         }
       ],
       "created": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "desc_type": "",
       "display_template": "",
       "edit_rows": "database_access_all",
       "edit_table": "database_access_all",
       "group_id": 79,
       "id": 0,
       "id_default_hidden": false,
       "max_col_id": 93,
       "max_row_id": 70,
       "name": "",
       "num_columns": 31,
       "num_rows": 48,
       "object": "databasetable",
       "short_desc": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "updated_default_hidden": false,
       "user_id": 39,
       "view_table": "database_access_all"
     }
   ],
   "end_item": 25,
   "has_more": false,
   "next_page_token": 14,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 97,
   "total_count": 59
}

View Database Table List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Database Rows#

GET /api/v1/getdatabaserows

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

database_id required integer	ID of the database.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are `created`, `row_num`, `updated`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getdatabaserows

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getdatabaserows' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'database_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("database_id", "12")
    endpoint := "https://groups.io/api/v1/getdatabaserows"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getdatabaserows");
    url.searchParams.append("database_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 41,
       "id": 77,
       "num_vals": 75,
       "object": "databaserow",
       "row_num": 86,
       "table_id": 35,
       "updated": "2009-11-10T15:00:00-08:00",
       "vals": [
         {
           "checked": false,
           "city": "",
           "col_id": 78,
           "col_type": "address_column",
           "country": "",
           "date": "2009-11-10T15:00:00-08:00",
           "desc": "",
           "github_avatar_url": "",
           "github_bio": "",
           "github_company": "",
           "github_email": "",
           "github_id": 40,
           "github_location": "",
           "github_login": "",
           "github_name": "",
           "github_profile_url": "",
           "html_text": "",
           "image_data": [
             ""
           ],
           "image_name": "",
           "lat": 3.2,
           "lng": 3.2,
           "multi_choice": [
             61
           ],
           "number": 3.2,
           "state": "",
           "street_address1": "",
           "street_address2": "",
           "text": "",
           "time": "2009-11-10T15:00:00-08:00",
           "title": "",
           "url": "",
           "zip": ""
         }
       ]
     }
   ],
   "end_item": 93,
   "has_more": false,
   "next_page_token": 20,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 68,
   "total_count": 42
}

View Database Row List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Add Database Row#

POST /api/v1/adddatabaserow

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the database_visible permission to use this call with a group. The database must also allow you to add rows.

Add a row to a database. Column values are set with per-column form fields named for the column type and ID (from the database column object): text_<colid> (text and paragraph columns), editor_<colid> (HTML paragraph columns), number_<colid>, checked_<colid> (true or false), choice_<colid> (the index of the choice within the column's choices array; 0 or empty clears the value), multichoice_<colid>_<n> (true to select choice n), date_<colid> (in your account's date format), time_<colid> (in your account's time format), address1_<colid>, address2_<colid>, city_<colid>, state_<colid>, zip_<colid> and country_<colid> (address columns), url_<colid>, title_<colid> and desc_<colid> (link columns), and email_<colid>. Image and GitHub columns cannot be set through the API. Column IDs come from getdatabases; they are not the columns' display positions.

Send parameters as application/x-www-form-urlencoded (recommended) or multipart/form-data. JSON request bodies are not supported; Accept: application/json controls the response format, not the request encoding. In Google Apps Script, pass a form object in the payload option of UrlFetchApp.fetch, not body.

POST Parameters

database_id required integer	ID of the database to add the row to.
csrf conditional string	Required only when authenticating with cookies. Pass the `csrf_token` from the user returned at login as the `csrf` form parameter. Not required with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

Returns the new database row object. Returns an error if parameters are invalid. Below are the unique errors to this call.

Additional Errors

"bad_request"	"missing database_id" is returned if the ID parameter is absent or empty.
"bad_request"	"invalid database_id: must be a positive integer" is returned if the ID is malformed, out of range, zero, or negative.
"bad_request"	"database_id not found" is returned if no record exists for the ID.
"bad_request"	"unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported" is returned for unsupported request body encodings.
"bad_request"	"invalid Content-Type" is returned if the Content-Type header is malformed.
"bad_request"	"invalid form data" is returned if the form cannot be parsed.
"bad_request"	"column ..." is returned if a required column is missing or a value is badly formatted. Note that a database with a required image or GitHub column cannot have rows added through the API, because those columns cannot be set through the API.
"inadequate_permissions"	"group is locked" is returned if the group is locked.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/adddatabaserow

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/adddatabaserow' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'database_id=12' \
  --data-urlencode 'text_3=Hello'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("database_id", "12")
    params.Add("text_3", "Hello")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/adddatabaserow", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/adddatabaserow");
    const body = new URLSearchParams();
    body.append("database_id", "12");
    body.append("text_3", "Hello");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 88,
   "id": 39,
   "num_vals": 5,
   "object": "databaserow",
   "row_num": 3,
   "table_id": 97,
   "updated": "2009-11-10T15:00:00-08:00",
   "vals": [
     {
       "checked": false,
       "city": "",
       "col_id": 34,
       "col_type": "address_column",
       "country": "",
       "date": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "github_avatar_url": "",
       "github_bio": "",
       "github_company": "",
       "github_email": "",
       "github_id": 25,
       "github_location": "",
       "github_login": "",
       "github_name": "",
       "github_profile_url": "",
       "html_text": "",
       "image_data": [
         ""
       ],
       "image_name": "",
       "lat": 3.2,
       "lng": 3.2,
       "multi_choice": [
         48
       ],
       "number": 3.2,
       "state": "",
       "street_address1": "",
       "street_address2": "",
       "text": "",
       "time": "2009-11-10T15:00:00-08:00",
       "title": "",
       "url": "",
       "zip": ""
     }
   ]
}

View Database Row definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing database_id"
}

"missing database_id" is returned if the ID parameter is absent or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid database_id: must be a positive integer"
}

"invalid database_id: must be a positive integer" is returned if the ID is malformed, out of range, zero, or negative.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "database_id not found"
}

"database_id not found" is returned if no record exists for the ID.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported"
}

"unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported" is returned for unsupported request body encodings.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid Content-Type"
}

"invalid Content-Type" is returned if the Content-Type header is malformed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid form data"
}

"invalid form data" is returned if the form cannot be parsed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "column ..."
}

"column ..." is returned if a required column is missing or a value is badly formatted. Note that a database with a required image or GitHub column cannot have rows added through the API, because those columns cannot be set through the API.

Example 400 · application/json · inadequate_permissions

{
  "object": "error",
  "type": "inadequate_permissions",
  "extra": "group is locked"
}

"group is locked" is returned if the group is locked.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Database Row#

POST /api/v1/updatedatabaserow

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the database_visible permission to use this call with a group. The database must also allow you to edit the row.

Update an existing database row. Column values omitted from the request are left unchanged. Column values are set with the same per-column form fields as adddatabaserow. Image and GitHub columns cannot be changed through the API; their existing values are preserved.

POST Parameters

row_id required integer	ID of the database row to update.
csrf conditional string	Required only when authenticating with cookies. Pass the `csrf_token` from the user returned at login as the `csrf` form parameter. Not required with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

Returns the updated database row object. Returns an error if parameters are invalid. Below are the unique errors to this call.

Additional Errors

"bad_request"	"missing row_id" is returned if the ID parameter is absent or empty.
"bad_request"	"invalid row_id: must be a positive integer" is returned if the ID is malformed, out of range, zero, or negative.
"bad_request"	"row_id not found" is returned if no record exists for the ID.
"bad_request"	"unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported" is returned for unsupported request body encodings.
"bad_request"	"invalid Content-Type" is returned if the Content-Type header is malformed.
"bad_request"	"invalid form data" is returned if the form cannot be parsed.
"bad_request"	"column ..." is returned if a required column is missing or a value is badly formatted.
"inadequate_permissions"	"group is locked" is returned if the group is locked.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatedatabaserow

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatedatabaserow' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'row_id=12' \
  --data-urlencode 'text_3=Replacement'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("row_id", "12")
    params.Add("text_3", "Replacement")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatedatabaserow", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatedatabaserow");
    const body = new URLSearchParams();
    body.append("row_id", "12");
    body.append("text_3", "Replacement");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 68,
   "id": 84,
   "num_vals": 11,
   "object": "databaserow",
   "row_num": 58,
   "table_id": 76,
   "updated": "2009-11-10T15:00:00-08:00",
   "vals": [
     {
       "checked": false,
       "city": "",
       "col_id": 18,
       "col_type": "address_column",
       "country": "",
       "date": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "github_avatar_url": "",
       "github_bio": "",
       "github_company": "",
       "github_email": "",
       "github_id": 63,
       "github_location": "",
       "github_login": "",
       "github_name": "",
       "github_profile_url": "",
       "html_text": "",
       "image_data": [
         ""
       ],
       "image_name": "",
       "lat": 3.2,
       "lng": 3.2,
       "multi_choice": [
         31
       ],
       "number": 3.2,
       "state": "",
       "street_address1": "",
       "street_address2": "",
       "text": "",
       "time": "2009-11-10T15:00:00-08:00",
       "title": "",
       "url": "",
       "zip": ""
     }
   ]
}

View Database Row definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing row_id"
}

"missing row_id" is returned if the ID parameter is absent or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid row_id: must be a positive integer"
}

"invalid row_id: must be a positive integer" is returned if the ID is malformed, out of range, zero, or negative.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "row_id not found"
}

"row_id not found" is returned if no record exists for the ID.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported"
}

"unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported" is returned for unsupported request body encodings.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid Content-Type"
}

"invalid Content-Type" is returned if the Content-Type header is malformed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid form data"
}

"invalid form data" is returned if the form cannot be parsed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "column ..."
}

"column ..." is returned if a required column is missing or a value is badly formatted.

Example 400 · application/json · inadequate_permissions

{
  "object": "error",
  "type": "inadequate_permissions",
  "extra": "group is locked"
}

"group is locked" is returned if the group is locked.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Database Row#

POST /api/v1/deletedatabaserow

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must have the database_visible permission to use this call with a group. The database must also allow you to edit the row.

Delete a database row. Any images in the row are also deleted.

POST Parameters

row_id required integer	ID of the database row to delete.
csrf conditional string	Required only when authenticating with cookies. Pass the `csrf_token` from the user returned at login as the `csrf` form parameter. Not required with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

Returns nothing if successful. Returns an error if parameters are invalid. Below are the unique errors to this call.

Additional Errors

"bad_request"	"missing row_id" is returned if the ID parameter is absent or empty.
"bad_request"	"invalid row_id: must be a positive integer" is returned if the ID is malformed, out of range, zero, or negative.
"bad_request"	"row_id not found" is returned if no record exists for the ID.
"bad_request"	"unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported" is returned for unsupported request body encodings.
"bad_request"	"invalid Content-Type" is returned if the Content-Type header is malformed.
"bad_request"	"invalid form data" is returned if the form cannot be parsed.
"inadequate_permissions"	"group is locked" is returned if the group is locked.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletedatabaserow

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletedatabaserow' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'row_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("row_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletedatabaserow", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletedatabaserow");
    const body = new URLSearchParams();
    body.append("row_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing row_id"
}

"missing row_id" is returned if the ID parameter is absent or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid row_id: must be a positive integer"
}

"invalid row_id: must be a positive integer" is returned if the ID is malformed, out of range, zero, or negative.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "row_id not found"
}

"row_id not found" is returned if no record exists for the ID.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported"
}

"unsupported Content-Type: send application/x-www-form-urlencoded or multipart/form-data; JSON bodies are not supported" is returned for unsupported request body encodings.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid Content-Type"
}

"invalid Content-Type" is returned if the Content-Type header is malformed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid form data"
}

"invalid form data" is returned if the form cannot be parsed.

Example 400 · application/json · inadequate_permissions

{
  "object": "error",
  "type": "inadequate_permissions",
  "extra": "group is locked"
}

"group is locked" is returned if the group is locked.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delivery

Get Delivery Info#

GET /api/v1/getdeliveryinfo

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get a user's group specific delivery information.

Query Parameters

group_id optional integer	ID of the group. If neither `group_id` nor `group_name` are specified, events from all subscriptions are returned.
group_name optional string	Name of the group. If neither `group_id` nor `group_name` are specified, events from all subscriptions are returned.
member_info_id optional integer	If specified, return the delivery information for this member. You must have the `manage_members` permission to specify this.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getdeliveryinfo

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getdeliveryinfo' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getdeliveryinfo"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getdeliveryinfo");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "attempt_msg_id": 54,
   "attempt_response": "",
   "attempt_subject": "",
   "attempt_time": "2009-11-10T15:00:00-08:00",
   "attempt_type": "delivery_bounce_probe",
   "bounces": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 54,
       "is_hard": false,
       "msg_id": 81,
       "object": "bounce_info",
       "response": "",
       "subject": "",
       "type": "delivery_bounce_probe"
     }
   ],
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 81,
   "object": "delivery_info",
   "success_msg_id": 99,
   "success_response": "",
   "success_subject": "",
   "success_time": "2009-11-10T15:00:00-08:00",
   "success_type": "delivery_bounce_probe",
   "updated": "2009-11-10T15:00:00-08:00"
}

View Delivery Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Bounce Info#

GET /api/v1/getbounceinfo

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

None.

Get a user's bounce information.

Query Parameters

limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are `id`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

	None.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getbounceinfo

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getbounceinfo' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getbounceinfo"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getbounceinfo");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Bounce Info List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Drafts

A draft represents 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 /uploadattachments.
Once complete, send the draft as a message with /postdraft.

There are also several draft maintenance endpoints.

New Draft#

POST /api/v1/newdraft

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Create a new draft object.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
draft_type required string	Type of draft. Currently, `draft_type_post`, `draft_type_reply`, `draft_type_post_to_sub` and `draft_type_dm` are the only allowed types.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
message_id conditional integer	If this is a 'draft_type_reply', you must specify the ID of the message you are replying to.
dm_member_id conditional integer	If this is a `draft_type_dm`, you must specify the ID of the member you are sending a message to.
member_id conditional integer	If this is a `draft_type_post_to_sub`, you must specify the ID of the member you are sending a message to. You can specify more than one member_ids.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newdraft

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newdraft' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newdraft", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newdraft");
    const body = new URLSearchParams();
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "bcc_all": false,
   "bcc_me": false,
   "body": "",
   "body_type": "",
   "created": "2009-11-10T15:00:00-08:00",
   "draft_type": "",
   "group_id": 57,
   "id": 95,
   "is_special": false,
   "message_id": 42,
   "next_attachment_id": 42,
   "num_attachments": 72,
   "object": "draft",
   "subject": "",
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 21
}

View Draft definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid draft_type"
}

"invalid draft_type" is returned if the draft type is missing or invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing dm_member_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Draft#

POST /api/v1/updatedraft

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be the owner of the draft.

Update a draft object.

POST Parameters

draft_id required integer	ID of the draft to update. You must be the owner of the draft.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
subject optional string	Subject of the draft.
body optional string	Body of the draft, in HTML.
is_special optional boolean	If this post should be sent as a special message (only applies to moderators/owners).
is_private optional boolean	If the private button has been toggled.
bcc_me optional boolean	If the sender should be BCC'ed when this draft is posted (only applies to `draft_type_reply`)
bcc_all optional boolean	If all moderators should be BCC'ed when this draft is posted (only applies to `draft_type_post_to_sub`).
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatedraft

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatedraft' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'draft_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("draft_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatedraft", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatedraft");
    const body = new URLSearchParams();
    body.append("draft_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "bcc_all": false,
   "bcc_me": false,
   "body": "",
   "body_type": "",
   "created": "2009-11-10T15:00:00-08:00",
   "draft_type": "",
   "group_id": 58,
   "id": 12,
   "is_special": false,
   "message_id": 52,
   "next_attachment_id": 46,
   "num_attachments": 7,
   "object": "draft",
   "subject": "",
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 59
}

View Draft definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid draft_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Drafts#

GET /api/v1/getdrafts

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

None

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getdrafts

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getdrafts' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getdrafts"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getdrafts");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "bcc_all": false,
       "bcc_me": false,
       "body": "",
       "body_type": "",
       "created": "2009-11-10T15:00:00-08:00",
       "draft_type": "",
       "group_id": 11,
       "id": 20,
       "is_special": false,
       "message_id": 37,
       "next_attachment_id": 7,
       "num_attachments": 37,
       "object": "draft",
       "subject": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 96
     }
   ],
   "end_item": 64,
   "has_more": false,
   "next_page_token": 96,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 40,
   "total_count": 73
}

View Draft List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Draft#

POST /api/v1/deletedraft

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be the owner of the draft.

Delete a draft object.

POST Parameters

draft_id required integer	ID of the draft to delete. You must be the owner of the draft.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletedraft

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletedraft' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'draft_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("draft_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletedraft", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletedraft");
    const body = new URLSearchParams();
    body.append("draft_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid draft_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Upload Attachments#

POST /api/v1/uploadattachments

Authentication: Bearer API key, Basic token, or session cookie Request: multipart/form-data Response: application/json

Permissions:

You must be the owner of the draft.

Upload attachments as part of a draft.

POST Parameters

draft_id required integer	ID of the draft to associate the attachment to. You must be the owner of the draft.
fileupload required multipart file	Multipart file upload of one or more attachments.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
inline optional boolean	If the attachments are inline images.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid draft_id" is returned if the draft id is missing or invalid.
"bad_request"	"content too large" is returned if the upload exceeds the maximum message size.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/uploadattachments

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/uploadattachments' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --form-string 'draft_id=12' \
  --form 'fileupload=@/path/to/attachment.pdf'

package main

import (
    "bytes"
    "fmt"
    "io"
    "mime/multipart"
    "net/http"
    "os"
    "path/filepath"
)

func main() {
    var requestBody bytes.Buffer
    writer := multipart.NewWriter(&requestBody)
    if err := writer.WriteField("draft_id", "12"); err != nil {
        panic(err)
    }
    {
        file, err := os.Open("/path/to/attachment.pdf")
        if err != nil {
            panic(err)
        }
        part, err := writer.CreateFormFile("fileupload", filepath.Base(file.Name()))
        if err != nil {
            file.Close()
            panic(err)
        }
        _, err = io.Copy(part, file)
        file.Close()
        if err != nil {
            panic(err)
        }
    }
    if err := writer.Close(); err != nil {
        panic(err)
    }
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/uploadattachments", &requestBody)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", writer.FormDataContentType())
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const { readFile } = await import('node:fs/promises');
    const url = new URL("https://groups.io/api/v1/uploadattachments");
    const body = new FormData();
    body.append("draft_id", "12");
    body.append("fileupload", new Blob([await readFile("/path/to/attachment.pdf")]), "attachment.pdf");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "content_type": "",
       "draft_id": 60,
       "filename": "",
       "id": 95,
       "inline": false,
       "object": "draft_attachment",
       "size": 57,
       "url": ""
     }
   ],
   "end_item": 24,
   "has_more": false,
   "next_page_token": 42,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 86,
   "total_count": 41
}

View Draft Attachment List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid draft_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "content too large"
}

"content too large" is returned if the upload exceeds the maximum message size.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Attachments#

GET /api/v1/getattachments

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must be the owner of the draft.

Get attachments.

POST Parameters

draft_id required integer	ID of the draft containing the attachments. You must be the owner of the draft.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getattachments

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getattachments' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'draft_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("draft_id", "12")
    endpoint := "https://groups.io/api/v1/getattachments"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getattachments");
    url.searchParams.append("draft_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "content_type": "",
       "draft_id": 59,
       "filename": "",
       "id": 17,
       "inline": false,
       "object": "draft_attachment",
       "size": 97,
       "url": ""
     }
   ],
   "end_item": 93,
   "has_more": false,
   "next_page_token": 46,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 79,
   "total_count": 68
}

View Draft Attachment List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid draft_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Attachment#

POST /api/v1/deleteattachment

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be the owner of the draft and attachment.

Delete an attachment.

POST Parameters

draft_id required integer	ID of the draft containing the attachment to delete. You must be the owner of the draft.
attachment_id required integer	Attachment ID to delete.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid 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.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deleteattachment

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deleteattachment' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'draft_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("draft_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deleteattachment", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deleteattachment");
    const body = new URLSearchParams();
    body.append("draft_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid draft_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid attachment_id"
}

"invalid attachment_id" is returned if the attachment ID is missing or invalid.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Post Draft#

POST /api/v1/postdraft

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Post Draft.

POST Parameters

draft_id required integer	ID of the draft to post. You must be the owner of the draft.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
reply optional string	Only applicable if this draft is a reply to a message. Possible values are: `sender`, `group_and_sender`, `mods`.
from_owner optional boolean	Only applicable if this draft is a new post and the poster is a moderator or owner of the group. If `true`, send the post from the groupname+owner email address.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Success Responses

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/postdraft

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/postdraft' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'draft_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("draft_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/postdraft", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/postdraft");
    const body = new URLSearchParams();
    body.append("draft_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid draft_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no subject"
}

"no subject" is returned if the draft is missing a subject.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no body"
}

"no body" is returned if the draft is missing a body.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "need hashtag"
}

"need hashtag" is returned if the subject needs a hashtag.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "restricted hashtag"
}

"restricted hashtag" is returned if the subject contains a hashtag that the user does not have permission to use.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "mod only hashtag"
}

"mod only hashtag" is returned if the subject contains a hashtag that only moderators/owners can use.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "private message"
}

"private message" is returned if the subject starts with "Private:".

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "post too big"
}

"post too big" is returned if the body is too large to send.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "announcement group"
}

"announcement group" is returned if the group is an announcement group and the sender is not a moderator/owner.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "group out of space"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "bad attachment"
}

"bad attachment" is returned if the message contains an attachment that isn't allowed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "not subscribed"
}

"not subscribed" is returned if the user is not subscribed to the group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid reply"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Events

With RSVPs, here is the flow:

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

Event Reminders:

Event reminders are notifications sent before an event starts. They support various time intervals and can be sent as regular or special notices.

Setting Reminders:

Reminders are specified using three parallel arrays: reminder_interval, reminder_type, and reminder_special
reminder_interval: The numeric amount (e.g., 15 for 15 minutes, 2 for 2 days)
reminder_type: The unit of time as a form value: "reminder_type_minutes", "reminder_type_hours", "reminder_type_days", "reminder_type_weeks"
reminder_special: "true" for a special notice, "false" for a regular notice. Supply a value for every reminder when mixing regular and special notices, to keep their positions aligned.

Examples:

15 minutes before: reminder_interval=15&reminder_type=reminder_type_minutes&reminder_special=false
1 hour before: reminder_interval=1&reminder_type=reminder_type_hours&reminder_special=false
2 days before: reminder_interval=2&reminder_type=reminder_type_days&reminder_special=false
1 week before: reminder_interval=1&reminder_type=reminder_type_weeks&reminder_special=false

Multiple Reminders: You can set multiple reminders by repeating each field name in the same order:

reminder_interval=15&reminder_type=reminder_type_minutes&reminder_special=false (15 minutes)
reminder_interval=1&reminder_type=reminder_type_hours&reminder_special=false (1 hour)
reminder_interval=1&reminder_type=reminder_type_days&reminder_special=true (1 day, special notice)

For Recurring Events:

Reminders apply to all occurrences in the series
When a series is updated, reminders are recalculated for all future events
Individual occurrences can have different reminders if they are overridden (detached)

Get Event#

GET /api/v1/getevent

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get a single event.

Query Parameters

event_id required integer	The ID of the event to return.

Returns

Returns the event object. Returns an error if parameters are invalid (e.g. specifying an invalid group_id). Below are the unique errors to this call. extended - optional, boolean: If true, the endpoint will return additional information. See Extended Return Information for more information.

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'event_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("event_id", "12")
    endpoint := "https://groups.io/api/v1/getevent"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getevent");
    url.searchParams.append("event_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Event definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid event_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "not subscribed to group"
}

"not subscribed to group" is returned if the event belongs to a group the user is not a member of.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Events#

GET /api/v1/getevents

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

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

Query Parameters

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

Additional Errors

	A `start_not_specified` error is returned if the start parameter is missing.
	An `invalid_start_time` error is returned if the start parameter cannot be parsed.
	An `invalid_end_time` error is returned if the end parameter cannot be parsed.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getevents

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getevents' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'start=2019-06-19' \
  --data-urlencode 'limit=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("start", "2019-06-19")
    params.Add("limit", "2")
    endpoint := "https://groups.io/api/v1/getevents"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getevents");
    url.searchParams.append("start", "2019-06-19");
    url.searchParams.append("limit", "2");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "additional_guests": false,
       "all_day": false,
       "color_hex": "",
       "color_name": "color_antique_pink",
       "comment_label": "",
       "created": "2009-11-10T15:00:00-08:00",
       "creator_name": "@JohnSmith",
       "description": "",
       "end_time": "2009-11-10T15:00:00-08:00",
       "group_id": 46,
       "group_name": "",
       "has_rsvp": false,
       "id": 22,
       "location": "",
       "max_attendees": 84,
       "name": "",
       "nice_group_name": "",
       "object": "event",
       "organizer_email": "",
       "organizer_name": "",
       "organizer_phone": "",
       "rsvp": false,
       "rsvp_additional_guests": 28,
       "rsvp_comment": "",
       "rsvp_type": "",
       "show_comments": false,
       "start_time": "2009-11-10T15:00:00-08:00",
       "timezone": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "yes_message": ""
     }
   ],
   "end_item": 31,
   "has_more": false,
   "next_page_token": 53,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 6,
   "total_count": 1
}

View Event List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

RSVP To An Event#

POST /api/v1/rsvp

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be subscribed to the group.

RSVP to an event.

POST Parameters

event_id required integer	ID of the event to RSVP to. You must be subscribed to the group.
response required string	Can be one of: `rsvp_maybe`, `rsvp_no`, `rsvp_yes`.
additional_guests required number
comment required string
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/rsvp

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/rsvp' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'event_id=12' \
  --data-urlencode 'response=rsvp_yes'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("event_id", "12")
    params.Add("response", "rsvp_yes")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/rsvp", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/rsvp");
    const body = new URLSearchParams();
    body.append("event_id", "12");
    body.append("response", "rsvp_yes");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "additional_guests": 17,
   "comment": "",
   "created": "2009-11-10T15:00:00-08:00",
   "email": "",
   "event_id": 61,
   "full_name": "",
   "group_id": 1,
   "id": 72,
   "object": "rsvp",
   "profile_photo_url": "",
   "type": "rsvp_maybe",
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 15,
   "user_name": ""
}

View RSVP definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid event_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "locked event"
}

"locked event" is returned if the event has been locked.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "not subscribed"
}

"not subscribed" is returned if the user is not subscribed to the group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "waitlist response"
}

"waitlist response" is returned if the response field is rsvp_waitlist.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Add Event#

POST /api/v1/addevent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have calendar management permissions for the group.

Add a new event.

POST Parameters

group_id required integer	ID of the group.
name required string	Event name.
description optional string	Event description.
location optional string	Event location.
start_time required string	Event start time in ISO 8601 format.
end_time required string	Event end time in ISO 8601 format.
timezone required string	Timezone for the event.
all_day optional boolean	Whether this is an all-day event.
rsvp optional boolean	Whether to request RSVPs.
max_attendees optional number	Maximum number of attendees.
additional_guests optional boolean	Whether to allow additional guests.
send_notice optional boolean	If true, a notice is sent to the group when the event starts, as a message tagged #cal-notice. This does not send an invitation; see send_invite.
send_invite optional boolean	If true, an invitation for the event, with an attached ICS calendar file, is sent to the group as a message tagged #cal-invite. On a moderated group the invitation may be held for approval; this does not affect the response.
organizer_name optional string	Organizer name.
organizer_email optional string	Organizer email.
organizer_phone optional string	Organizer phone.
color optional string	Event color.
format optional number	Event format (plain text, markdown, etc).
yes_message optional string	Message to show when someone RSVPs yes.
comment_label optional string	Label for the comment field.
show_comments optional boolean	Whether RSVP comments are visible to all members, not just event organizers.
reminder_interval optional number repeated field	Array of reminder intervals. The amount of time before the event to send the reminder.
reminder_type optional string repeated field	Array of reminder types. Values: "reminder_type_minutes", "reminder_type_hours", "reminder_type_days", "reminder_type_weeks".
reminder_special optional string repeated field	Array of special notice flags. Set to "true" to send as special notice, "false" for regular reminder.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information.

Setting Reminders

Reminders are sent before an event starts. Provide repeated fields in matching order:

reminder_interval=15&reminder_type=reminder_type_minutes&reminder_special=false (15 minutes before)
reminder_interval=1&reminder_type=reminder_type_days&reminder_special=false (1 day before)
reminder_interval=1&reminder_type=reminder_type_weeks&reminder_special=true (1 week before, special notice)

Returns

Returns the created event object. Returns an error if parameters are invalid.

Additional Errors

"bad_request"	"invalid name" is returned if the event name is missing or empty.
"bad_request"	"invalid subscription" is returned if the user is not subscribed to the group.
"bad_request"	"invalid group" is returned if the group is invalid.
"bad_request"	"no permission" is returned if the user doesn't have calendar management permissions.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/addevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/addevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'name=Team Meeting' \
  --data-urlencode 'start_time=2024-01-15T10:00:00Z' \
  --data-urlencode 'end_time=2024-01-15T11:00:00Z' \
  --data-urlencode 'timezone=America/New_York' \
  --data-urlencode 'reminder_interval=15' \
  --data-urlencode 'reminder_type=reminder_type_minutes' \
  --data-urlencode 'reminder_special=false' \
  --data-urlencode 'reminder_interval=1' \
  --data-urlencode 'reminder_type=reminder_type_days' \
  --data-urlencode 'reminder_special=true'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("name", "Team Meeting")
    params.Add("start_time", "2024-01-15T10:00:00Z")
    params.Add("end_time", "2024-01-15T11:00:00Z")
    params.Add("timezone", "America/New_York")
    params.Add("reminder_interval", "15")
    params.Add("reminder_type", "reminder_type_minutes")
    params.Add("reminder_special", "false")
    params.Add("reminder_interval", "1")
    params.Add("reminder_type", "reminder_type_days")
    params.Add("reminder_special", "true")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/addevent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/addevent");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("name", "Team Meeting");
    body.append("start_time", "2024-01-15T10:00:00Z");
    body.append("end_time", "2024-01-15T11:00:00Z");
    body.append("timezone", "America/New_York");
    body.append("reminder_interval", "15");
    body.append("reminder_type", "reminder_type_minutes");
    body.append("reminder_special", "false");
    body.append("reminder_interval", "1");
    body.append("reminder_type", "reminder_type_days");
    body.append("reminder_special", "true");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Event definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

"invalid name" is returned if the event name is missing or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid subscription"
}

"invalid subscription" is returned if the user is not subscribed to the group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group"
}

"invalid group" is returned if the group is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no permission"
}

"no permission" is returned if the user doesn't have calendar management permissions.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Event#

POST /api/v1/updateevent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have calendar management permissions for the group or be the event creator.

Update an existing event. This call replaces the editable event settings; it is not a partial update. Omitted description, location, organizer fields, yes_message and comment_label are cleared. Omitted booleans become false, and omitted format and max_attendees become 0. Resubmit the values you want to preserve. Color is preserved when omitted; all reminders are replaced, and omitting reminders removes them.

POST Parameters

event_id required integer	ID of the event to update.
name required string	Event name.
description optional string	Event description.
location optional string	Event location.
start_time required string	Event start time in ISO 8601 format.
end_time required string	Event end time in ISO 8601 format.
timezone required string	Timezone for the event.
all_day optional boolean	Whether this is an all-day event.
rsvp optional boolean	Whether to request RSVPs.
max_attendees optional number	Maximum number of attendees.
additional_guests optional boolean	Whether to allow additional guests.
send_notice optional boolean	If true, a notice is sent to the group when the event starts, as a message tagged #cal-notice. This does not send an invitation; see send_invite.
send_invite optional boolean	If true, an invitation for the event, with an attached ICS calendar file, is sent to the group as a message tagged #cal-invite. On a moderated group the invitation may be held for approval; this does not affect the response.
organizer_name optional string	Organizer name.
organizer_email optional string	Organizer email.
organizer_phone optional string	Organizer phone.
color optional string	Event color.
format optional number	Event format (plain text, markdown, etc).
yes_message optional string	Message to show when someone RSVPs yes.
comment_label optional string	Label for the comment field.
show_comments optional boolean	Whether RSVP comments are visible to all members, not just event organizers.
reminder_interval optional number repeated field	Array of reminder intervals. The amount of time before the event to send the reminder.
reminder_type optional string repeated field	Array of reminder types. Values: "reminder_type_minutes", "reminder_type_hours", "reminder_type_days", "reminder_type_weeks".
reminder_special optional string repeated field	Array of special notice flags. Set to "true" to send as special notice, "false" for regular reminder.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information.

Updating Reminders

To update reminders, provide new arrays which will replace all existing reminders:

reminder_interval=30&reminder_type=reminder_type_minutes&reminder_special=false (30 minutes before)
To remove all reminders, omit the reminder parameters entirely

Returns

Returns success status. Returns an error if parameters are invalid.

Additional Errors

"bad_request"	"invalid name" is returned if the event name is missing or empty.
"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.
	"inadequate_permissions" is returned if the user doesn't have permission to edit the event. A user may edit an event if they created it, are a moderator, or their email matches the event's organizer email.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updateevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updateevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'event_id=123' \
  --data-urlencode 'name=Updated Meeting' \
  --data-urlencode 'start_time=2024-01-15T10:00:00Z' \
  --data-urlencode 'end_time=2024-01-15T11:00:00Z' \
  --data-urlencode 'timezone=America/New_York' \
  --data-urlencode 'reminder_interval=30' \
  --data-urlencode 'reminder_type=reminder_type_minutes' \
  --data-urlencode 'reminder_special=false'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("event_id", "123")
    params.Add("name", "Updated Meeting")
    params.Add("start_time", "2024-01-15T10:00:00Z")
    params.Add("end_time", "2024-01-15T11:00:00Z")
    params.Add("timezone", "America/New_York")
    params.Add("reminder_interval", "30")
    params.Add("reminder_type", "reminder_type_minutes")
    params.Add("reminder_special", "false")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updateevent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updateevent");
    const body = new URLSearchParams();
    body.append("event_id", "123");
    body.append("name", "Updated Meeting");
    body.append("start_time", "2024-01-15T10:00:00Z");
    body.append("end_time", "2024-01-15T11:00:00Z");
    body.append("timezone", "America/New_York");
    body.append("reminder_interval", "30");
    body.append("reminder_type", "reminder_type_minutes");
    body.append("reminder_special", "false");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Success definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

"invalid name" is returned if the event name is missing or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid event_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "locked event"
}

"locked event" is returned if the event has been locked.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Add Repeat Event#

POST /api/v1/addrepeatevent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have calendar management permissions for the group.

Add a new repeating event series.

POST Parameters

group_id required integer	ID of the group.
name required string	Name of the event series.
description optional string	Description of the event series.
location optional string	Location of the event series.
start_time required string	Start time of first occurrence in RFC3339 format.
duration required number	Duration of each event in seconds.
timezone required string	Timezone for the event series (e.g., "America/New_York").
all_day optional boolean	Whether this is an all-day event series.
repeat_type required number	Type of repeat (0=daily, 1=every weekday, 2=every Monday/Wednesday/Friday, 3=every Tuesday/Thursday, 4=weekly on the days given by sun..sat, 5=monthly, 6=yearly).
repeat_interval optional number	Interval for repeating (e.g., every 2 weeks). Default is 1. Default: `1`
repeat_ends required number	How the repeat ends (0=never, 1=times, 2=date).
repeat_until optional string	End date for repeating events (required if repeat_ends=2).
repeat_times optional number	Number of times to repeat (required if repeat_ends=1).
sun, mon, tue, wed, thu, fri, sat optional boolean	Days of week for weekly repeats. At least one is required when repeat_type=4; ignored for all other repeat types.
month_type optional number	Type of monthly repeat (0=day of week of the month, e.g. the second Tuesday, 1=day of the month, 2=last day of the month, 3=last day of week of the month, e.g. the last Tuesday).
organizer_name optional string	Name of the event organizer.
organizer_email optional string	Email of the event organizer.
organizer_phone optional string	Phone of the event organizer.
color optional string	Color for the event series.
format optional number	Format of the description (0=plain, 1=markdown, 2=html).
max_attendees optional number	Maximum number of attendees per event.
rsvp optional boolean	Whether RSVP is required.
additional_guests optional boolean	Whether attendees can bring guests.
send_notice optional boolean	If true, a notice is sent to the group when each event in the series starts, as a message tagged #cal-notice. This does not send an invitation; see send_invite.
send_invite optional boolean	If true, an invitation for the series, with an attached ICS calendar file, is sent to the group as a message tagged #cal-invite. On a moderated group the invitation may be held for approval; this does not affect the response.
yes_message optional string	Message shown when RSVP is yes.
comment_label optional string	Label for the comment field.
show_comments optional boolean	Whether RSVP comments are visible to all members, not just event organizers.
reminder_interval optional number repeated field	Array of reminder intervals. The amount of time before each event occurrence to send the reminder.
reminder_type optional string repeated field	Array of reminder types. Values: "reminder_type_minutes", "reminder_type_hours", "reminder_type_days", "reminder_type_weeks".
reminder_special optional string repeated field	Array of special notice flags. Set to "true" to send as special notice, "false" for regular reminder.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information.

Setting Reminders for Recurring Events

Reminders apply to all occurrences in the series:

reminder_interval=15&reminder_type=reminder_type_minutes&reminder_special=false (15 minutes before each occurrence)
reminder_interval=1&reminder_type=reminder_type_hours&reminder_special=false (1 hour before each occurrence)
reminder_interval=1&reminder_type=reminder_type_days&reminder_special=true (1 day before, special notice)

Returns

Returns the created repeat event object. Returns an error if parameters are invalid.

Additional Errors

"bad_request"	"invalid name" is returned if the event name is missing or empty.
"bad_request"	"invalid subscription" is returned if the user is not subscribed to the group.
"bad_request"	"invalid group" is returned if the group is invalid.
"bad_request"	"no permission" is returned if the user doesn't have calendar management permissions.
"bad_request"	"invalid repeat_type" is returned if repeat_type is not one of the values listed above.
"bad_request"	"invalid timezone" is returned if the timezone cannot be parsed.
"bad_request"	"no days selected" is returned if repeat_type=4 and no days of the week are selected.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/addrepeatevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/addrepeatevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'name=Team Sync' \
  --data-urlencode 'start_time=2024-01-15T14:00:00Z' \
  --data-urlencode 'duration=3600' \
  --data-urlencode 'timezone=America/New_York' \
  --data-urlencode 'repeat_type=4' \
  --data-urlencode 'repeat_interval=1' \
  --data-urlencode 'repeat_ends=0' \
  --data-urlencode 'mon=true' \
  --data-urlencode 'wed=true' \
  --data-urlencode 'fri=true' \
  --data-urlencode 'reminder_interval=1' \
  --data-urlencode 'reminder_type=reminder_type_hours' \
  --data-urlencode 'reminder_special=false'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("name", "Team Sync")
    params.Add("start_time", "2024-01-15T14:00:00Z")
    params.Add("duration", "3600")
    params.Add("timezone", "America/New_York")
    params.Add("repeat_type", "4")
    params.Add("repeat_interval", "1")
    params.Add("repeat_ends", "0")
    params.Add("mon", "true")
    params.Add("wed", "true")
    params.Add("fri", "true")
    params.Add("reminder_interval", "1")
    params.Add("reminder_type", "reminder_type_hours")
    params.Add("reminder_special", "false")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/addrepeatevent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/addrepeatevent");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("name", "Team Sync");
    body.append("start_time", "2024-01-15T14:00:00Z");
    body.append("duration", "3600");
    body.append("timezone", "America/New_York");
    body.append("repeat_type", "4");
    body.append("repeat_interval", "1");
    body.append("repeat_ends", "0");
    body.append("mon", "true");
    body.append("wed", "true");
    body.append("fri", "true");
    body.append("reminder_interval", "1");
    body.append("reminder_type", "reminder_type_hours");
    body.append("reminder_special", "false");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Event definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

"invalid name" is returned if the event name is missing or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid subscription"
}

"invalid subscription" is returned if the user is not subscribed to the group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group"
}

"invalid group" is returned if the group is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no permission"
}

"no permission" is returned if the user doesn't have calendar management permissions.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid repeat_type"
}

"invalid repeat_type" is returned if repeat_type is not one of the values listed above.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid timezone"
}

"invalid timezone" is returned if the timezone cannot be parsed.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no days selected"
}

"no days selected" is returned if repeat_type=4 and no days of the week are selected.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Event#

POST /api/v1/deleteevent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have calendar management permissions for the group or be the event creator.

Delete an event.

POST Parameters

event_id required integer	ID of the event to delete.
send_cancel optional boolean	If true, a cancellation notice, with an attached ICS calendar file, is sent to the group as a message tagged #cal-cancelled. On a moderated group the notice may be held for approval; this does not affect the response.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information.

Returns

Returns success status. Returns an error if parameters are invalid.

Additional Errors

"bad_request"	"invalid event_id" is returned if the event id is missing or invalid.
	"inadequate_permissions" is returned if the user doesn't have permission to delete the event. A user may delete an event if they created it, are a moderator, or their email matches the event's organizer email.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deleteevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deleteevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'event_id=123'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("event_id", "123")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deleteevent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deleteevent");
    const body = new URLSearchParams();
    body.append("event_id", "123");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Success definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid event_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Repeat Event#

POST /api/v1/updaterepeatevent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have calendar management permissions for the group or be the event creator.

Update a repeating event series. This call replaces the editable series settings; it is not a partial update. Resubmit text, numeric, boolean, recurrence and reminder values you want to preserve. Omitted text fields are cleared, omitted booleans become false, and omitted numeric settings use their defaults. Color is preserved when omitted. Omitting reminders removes all reminders.

POST Parameters

repeat_event_id required integer	ID of the repeat event to update.
name required string	Name of the event.
description optional string	Description of the event.
location optional string	Location of the event.
start_time required string	Start time in RFC3339 format.
end_time required string	End time in RFC3339 format.
timezone required string	Timezone for the event (e.g., "America/New_York").
all_day optional boolean	Whether this is an all-day event.
repeat_type required number	Type of repeat (0=daily, 1=every weekday, 2=every Monday/Wednesday/Friday, 3=every Tuesday/Thursday, 4=weekly on the days given by sun..sat, 5=monthly, 6=yearly).
repeat_interval optional number	Interval for repeating (e.g., every 2 weeks).
repeat_ends required number	How the repeat ends (0=never, 1=times, 2=date).
repeat_until optional string	End date for repeating events (required if repeat_ends=2).
repeat_times optional number	Number of times to repeat (required if repeat_ends=1).
sun, mon, tue, wed, thu, fri, sat optional boolean	Days of week for weekly repeats. At least one is required when repeat_type=4; ignored for all other repeat types.
month_type optional number	Type of monthly repeat (0=day of week of the month, e.g. the second Tuesday, 1=day of the month, 2=last day of the month, 3=last day of week of the month, e.g. the last Tuesday).
organizer_name optional string	Name of the event organizer.
organizer_email optional string	Email of the event organizer.
organizer_phone optional string	Phone of the event organizer.
color optional string	Color for the event.
format optional number	Format of the description (0=plain, 1=markdown, 2=html).
max_attendees optional number	Maximum number of attendees.
rsvp optional boolean	Whether RSVP is required.
additional_guests optional boolean	Whether attendees can bring guests.
send_notice optional boolean	If true, a notice is sent to the group when the event starts, as a message tagged #cal-notice. This does not send an invitation; see send_invite.
send_invite optional boolean	If true, an updated invitation for the series, with an attached ICS calendar file, is sent to the group as a message tagged #cal-invite. On a moderated group the invitation may be held for approval; this does not affect the response.
yes_message optional string	Message shown when RSVP is yes.
comment_label optional string	Label for the comment field.
show_comments optional boolean	Whether RSVP comments are visible to all members, not just event organizers.
reminder_interval optional number repeated field	Array of reminder intervals. The amount of time before each event occurrence to send the reminder.
reminder_type optional string repeated field	Array of reminder types. Values: "reminder_type_minutes", "reminder_type_hours", "reminder_type_days", "reminder_type_weeks".
reminder_special optional string repeated field	Array of special notice flags. Set to "true" to send as special notice, "false" for regular reminder.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information.

Updating Reminders for Repeating Events

When updating reminders for a series, the new reminders apply to all future occurrences:

reminder_interval=15&reminder_type=reminder_type_minutes&reminder_special=false (15 minutes before each occurrence)
reminder_interval=1&reminder_type=reminder_type_hours&reminder_special=false (1 hour before each occurrence)
Reminders are automatically recalculated for all instances in the series
To remove all reminders, omit the reminder parameters entirely

Returns

Returns success status. Returns an error if parameters are invalid.

Additional Errors

"bad_request"	"invalid name" is returned if the event name is missing or empty.
"bad_request"	"invalid repeat_event_id" is returned if the repeat event id is missing or invalid.
	"inadequate_permissions" is returned if the user doesn't have permission to update the event. A user may edit a repeating event if they created it, are a moderator, or their email matches the event's organizer email.
"bad_request"	"no days selected" is returned for weekly repeats with no days selected.
"bad_request"	"invalid repeat_type" is returned if repeat_type is not one of the values listed above.
"bad_request"	"invalid timezone" is returned if the timezone cannot be parsed.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updaterepeatevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updaterepeatevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'repeat_event_id=123' \
  --data-urlencode 'name=Weekly Meeting' \
  --data-urlencode 'start_time=2024-01-15T10:00:00Z' \
  --data-urlencode 'end_time=2024-01-15T11:00:00Z' \
  --data-urlencode 'timezone=America/New_York' \
  --data-urlencode 'repeat_type=4' \
  --data-urlencode 'repeat_interval=1' \
  --data-urlencode 'repeat_ends=0' \
  --data-urlencode 'mon=true' \
  --data-urlencode 'wed=true' \
  --data-urlencode 'fri=true'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("repeat_event_id", "123")
    params.Add("name", "Weekly Meeting")
    params.Add("start_time", "2024-01-15T10:00:00Z")
    params.Add("end_time", "2024-01-15T11:00:00Z")
    params.Add("timezone", "America/New_York")
    params.Add("repeat_type", "4")
    params.Add("repeat_interval", "1")
    params.Add("repeat_ends", "0")
    params.Add("mon", "true")
    params.Add("wed", "true")
    params.Add("fri", "true")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updaterepeatevent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updaterepeatevent");
    const body = new URLSearchParams();
    body.append("repeat_event_id", "123");
    body.append("name", "Weekly Meeting");
    body.append("start_time", "2024-01-15T10:00:00Z");
    body.append("end_time", "2024-01-15T11:00:00Z");
    body.append("timezone", "America/New_York");
    body.append("repeat_type", "4");
    body.append("repeat_interval", "1");
    body.append("repeat_ends", "0");
    body.append("mon", "true");
    body.append("wed", "true");
    body.append("fri", "true");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Success definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

"invalid name" is returned if the event name is missing or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid repeat_event_id"
}

"invalid repeat_event_id" is returned if the repeat event id is missing or invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no days selected"
}

"no days selected" is returned for weekly repeats with no days selected.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid repeat_type"
}

"invalid repeat_type" is returned if repeat_type is not one of the values listed above.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid timezone"
}

"invalid timezone" is returned if the timezone cannot be parsed.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Repeat Event#

POST /api/v1/deleterepeatevent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have calendar management permissions for the group or be the event creator.

Delete a repeating event series.

POST Parameters

repeat_event_id required integer	ID of the repeat event to delete.
send_cancel optional boolean	If true, a cancellation notice, with an attached ICS calendar file, is sent to the group as a message tagged #cal-cancelled. On a moderated group the notice may be held for approval; this does not affect the response.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information.

Returns

Returns success status. Returns an error if parameters are invalid.

Additional Errors

"bad_request"	"invalid repeat_event_id" is returned if the repeat event id is missing or invalid.
	"inadequate_permissions" is returned if the user doesn't have permission to delete the event. A user may delete an event if they created it, are a moderator, or their email matches the event's organizer email.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deleterepeatevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deleterepeatevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'repeat_event_id=123'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("repeat_event_id", "123")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deleterepeatevent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deleterepeatevent");
    const body = new URLSearchParams();
    body.append("repeat_event_id", "123");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Success definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid repeat_event_id"
}

"invalid repeat_event_id" is returned if the repeat event id is missing or invalid.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Split Repeat Event#

POST /api/v1/splitrepeatevent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have calendar management permissions for the group or be the event creator.

Split a repeating event series at a specific point ("This and Future" functionality).

POST Parameters

repeat_event_id required integer	ID of the repeat event to split.
split_time required string	ISO 8601 timestamp where to split the series.
name required string	Name of the new event series.
description optional string	Description of the new event series.
location optional string	Location of the new event series.
timezone optional string	Timezone of the new event series.
organizer_name optional string	Organizer name for the new series.
organizer_email optional string	Organizer email for the new series.
organizer_phone optional string	Organizer phone for the new series.
yes_message optional string	RSVP yes message for the new series.
comment_label optional string	Comment label for the new series.
show_comments optional boolean	Whether RSVP comments are visible to all members for the new series.
color optional string	Color of the new event series.
format optional number	Format type for the new event series.
max_attendees optional number	Maximum attendees for the new series.
all_day optional boolean	Whether the new series is all day.
rsvp optional boolean	Whether RSVP is enabled for the new series.
additional_guests optional boolean	Whether additional guests are allowed.
send_notice optional boolean	If true, a notice is sent to the group when each event in the new series starts, as a message tagged #cal-notice. This does not send an invitation; see send_invite.
send_invite optional boolean	If true, an invitation for the new series, with an attached ICS calendar file, is sent to the group as a message tagged #cal-invite. On a moderated group the invitation may be held for approval; this does not affect the response.
start_time required string	ISO 8601 start time for the new series.
duration required number	Duration in seconds for the new series.
type required string	Type of repeat pattern (daily, weekly, monthly, yearly).
frequency required number	Repeat every N days/weeks/months/years.
sun, mon, tue, wed, thu, fri, sat optional boolean	For weekly repeats, which days.
monthly_type optional string	For monthly repeats, the type (day_of_month, day_of_week).
repeat_ends required string	How the new series ends (never, date, times).
repeat_until optional string	ISO 8601 end date if repeat_ends is "date".
repeat_times optional number	Number of occurrences if repeat_ends is "times".
reminder_interval optional number repeated field	Array of reminder intervals for the new series. The amount of time before each event occurrence to send the reminder.
reminder_type optional string repeated field	Array of reminder types for the new series. Values: "reminder_type_minutes", "reminder_type_hours", "reminder_type_days", "reminder_type_weeks".
reminder_special optional string repeated field	Array of special notice flags for the new series. Set to "true" to send as special notice, "false" for regular reminder.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information.

Splitting Series with Different Reminders

When splitting a series, you can set different reminders for the new series:

The original series keeps its existing reminders up to the split point
The new series uses the reminders specified in the request
Example: Split a daily meeting to change from 15-minute reminders to 1-hour reminders
- reminder_interval=1&reminder_type=reminder_type_hours&reminder_special=false (1 hour before each future occurrence)

Returns

Returns the created repeat event. Returns an error if parameters are invalid.

Additional Errors

"bad_request"	"invalid repeat_event_id" is returned if the repeat event id is missing or invalid.
	"inadequate_permissions" is returned if the user doesn't have permission to split the event. A user may modify a repeating event if they created it, are a moderator, or their email matches the event's organizer email.
"bad_request"	"invalid split_time" is returned if the split time is invalid.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/splitrepeatevent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/splitrepeatevent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'repeat_event_id=123' \
  --data-urlencode 'split_time=2024-01-10T09:00:00Z' \
  --data-urlencode 'name=Modified Meeting' \
  --data-urlencode 'start_time=2024-01-10T10:00:00Z' \
  --data-urlencode 'duration=3600' \
  --data-urlencode 'type=daily' \
  --data-urlencode 'frequency=1' \
  --data-urlencode 'repeat_ends=never'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("repeat_event_id", "123")
    params.Add("split_time", "2024-01-10T09:00:00Z")
    params.Add("name", "Modified Meeting")
    params.Add("start_time", "2024-01-10T10:00:00Z")
    params.Add("duration", "3600")
    params.Add("type", "daily")
    params.Add("frequency", "1")
    params.Add("repeat_ends", "never")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/splitrepeatevent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/splitrepeatevent");
    const body = new URLSearchParams();
    body.append("repeat_event_id", "123");
    body.append("split_time", "2024-01-10T09:00:00Z");
    body.append("name", "Modified Meeting");
    body.append("start_time", "2024-01-10T10:00:00Z");
    body.append("duration", "3600");
    body.append("type", "daily");
    body.append("frequency", "1");
    body.append("repeat_ends", "never");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Event definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid repeat_event_id"
}

"invalid repeat_event_id" is returned if the repeat event id is missing or invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid split_time"
}

"invalid split_time" is returned if the split time is invalid.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Feed

Get Feed#

GET /api/v1/getfeed

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

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

Query Parameters

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getfeed

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getfeed' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getfeed"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getfeed");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "chats": [
         {
           "id": 52691321,
           "object": "chat",
           "created": "2020-09-15T02:30:00-07:00",
           "updated": "2021-03-01T18:07:00-08:00",
           "user_id": 147779411,
           "profile_photo_url": "",
           "name": "",
           "can_view_profile": false,
           "group_id": 8658933,
           "subject": "Including.",
           "desc": "Tribe anything from.",
           "is_closed": false,
           "num_messages": 21,
           "chat_sub": {
             "id": 179889653,
             "object": "chat_sub",
             "created": "2020-09-10T11:42:00-07:00",
             "updated": "2023-03-29T23:48:00-07:00",
             "user_id": 147779411,
             "group_id": 8658933,
             "chat_id": 52691321,
             "last_msg_seen": 40
           }
         }
       ],
       "events": [
         {
           "additional_guests": false,
           "all_day": false,
           "color_hex": "",
           "color_name": "color_antique_pink",
           "comment_label": "",
           "created": "2009-11-10T15:00:00-08:00",
           "creator_name": "@JohnSmith",
           "description": "",
           "end_time": "2009-11-10T15:00:00-08:00",
           "group_id": 15,
           "group_name": "",
           "has_rsvp": false,
           "id": 67,
           "location": "",
           "max_attendees": 72,
           "name": "",
           "nice_group_name": "",
           "object": "event",
           "organizer_email": "",
           "organizer_name": "",
           "organizer_phone": "",
           "rsvp": false,
           "rsvp_additional_guests": 52,
           "rsvp_comment": "",
           "rsvp_type": "",
           "show_comments": false,
           "start_time": "2009-11-10T15:00:00-08:00",
           "timezone": "",
           "updated": "2009-11-10T15:00:00-08:00",
           "yes_message": ""
         }
       ],
       "files": [
         {
           "id": 52691321,
           "object": "file",
           "created": "2020-09-15T02:30:00-07:00",
           "updated": "2021-03-01T18:07:00-08:00",
           "user_id": 147779411,
           "group_id": 8658933,
           "name": "Kelsi Ledner",
           "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
           "size": 132787700,
           "path": "topfolder/subfolder",
           "parent_folder_id": 0,
           "type": "file_type_file",
           "count": 2,
           "media_type": "text/plain",
           "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
           "display_name": "Lawson Kreiger",
           "user_name": "Dickens6041",
           "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
           "profile_privacy": "profile_private",
           "email": "gersonbeahan@..."
         }
       ],
       "group": {
         "id": 8658933,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "StrategyHub",
         "nice_group_name": "",
         "alias": "",
         "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
         "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
         "subject_tag": "[StrategyHub]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "invite_only": false,
         "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_by_members",
         "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,
         "two_factor_policy": "group_2fa_policy_none",
         "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,
         "ai_summaries_enabled": false,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 541,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "2020-09-07T19:38:00-07: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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "email_address": "StrategyHub@groups.io",
         "extra_member_data_columns": [
           {
             "id": 48876437,
             "name": "Text: Lots write point week doctor.",
             "type": "text_column",
             "required": true,
             "color": "color_beige",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Movement whose also it vanish watch these to ever always."
           },
           {
             "id": 161476183,
             "name": "Paragraph: Other few covey range window.",
             "type": "paragraph_column",
             "required": true,
             "color": "color_light_brown",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Silence lastly had what outcome let while school pause up."
           },
           {
             "id": 39354277,
             "name": "Checkbox: Company freedom pout his throw.",
             "type": "checkbox_column",
             "required": true,
             "color": "color_orange",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Quarterly outfit faithful is often part whom these been hourly."
           },
           {
             "id": 8897324,
             "name": "Multiple Choice: Madagascan anyway should late yours.",
             "type": "multiple_choice_column",
             "required": true,
             "color": "color_orchid",
             "choices": [
               "Monthly ball upon almost everything dynasty.",
               "Behalf shall nearly this weekly for.",
               "Anywhere everybody over secondly then boat."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Besides pack when murder her had snore first in limp."
           },
           {
             "id": 159828550,
             "name": "Date: Which these bale nobody few.",
             "type": "date_column",
             "required": true,
             "color": "color_blush",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "How anyone these string life that who result lately yourselves."
           },
           {
             "id": 185149472,
             "name": "Time: Besides later whom for rarely.",
             "type": "time_column",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Each her ski ours host our as did they to."
           },
           {
             "id": 166814414,
             "name": "Address: Bravery where this as cloud.",
             "type": "address_column",
             "required": true,
             "color": "color_cucumber",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Inside since open most you that including fight murder cautiously."
           },
           {
             "id": 102385421,
             "name": "Multi Choice: Another what full her can.",
             "type": "multi_choice_column",
             "required": true,
             "color": "color_aquamute",
             "choices": [
               "Indeed besides motherhood in that nightly.",
               "Limit we kneel herself collect yourselves.",
               "Yourselves Norwegian this fear happily fruit."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pout nature bike moreover from whoever afterwards myself mine to."
           },
           {
             "id": 154317202,
             "name": "Link: Bale sedge Christian would whose.",
             "type": "link_column",
             "required": true,
             "color": "color_military",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Hers pack rhythm that now whose her out infancy somebody."
           },
           {
             "id": 123191768,
             "name": "Image: Today scenic consequently ours eye.",
             "type": "image_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Other other abundant some anywhere this life nevertheless in next."
           },
           {
             "id": 53386358,
             "name": "HTML Paragraph: Nobody what today e.g. loss.",
             "type": "html_paragraph_column",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Spite Philippine before throughout wander of as there next of."
           },
           {
             "id": 45812071,
             "name": "Email: That because am terribly many.",
             "type": "email_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Because anyone does you hungrily can several might who monthly."
           }
         ]
       },
       "hashtags": [
         {
           "id": 541,
           "object": "hashtag",
           "created": "2020-09-17T11:22:00-07:00",
           "group_id": 1188,
           "name": "Karl",
           "mods_only_post": false,
           "mods_only_replies": false,
           "no_email": false,
           "moderated": false,
           "special": true,
           "replies_unmoderated": false,
           "locked": true,
           "until": "hashtag_delete_month",
           "close_instead_of_delete": true,
           "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
           "color_name": "pink",
           "color_hex": "#f39de4",
           "reply_to": "thread_reply_to_sender",
           "topic_count": 1789,
           "last_message_date": "2020-09-08T01:22:00-07:00",
           "muted": null,
           "followed": null
         }
       ],
       "member_info": {
         "id": 93846546,
         "object": "member_info",
         "created": "2020-09-09T04:11:00-07:00",
         "updated": "2022-06-08T07:16:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "group_name": "StrategyHub",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_digest",
         "message_selection": "message_selection_follow_and_first_message",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_medium",
         "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "In hotel furniture anyone weakly besides",
         "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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "member_labels": [
           {
             "id": 726,
             "object": "memberlabel",
             "created": "2020-09-29T22:19:00Z",
             "group_id": 1857,
             "name": "Florida",
             "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
             "color_name": "green-sage",
             "color_hex": "#9fc4ac"
           },
           {
             "id": 1594,
             "object": "memberlabel",
             "created": "2020-09-24T02:24:00Z",
             "group_id": 42,
             "name": "Russel",
             "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
             "color_name": "purple",
             "color_hex": "#837fd5"
           },
           {
             "id": 1189,
             "object": "memberlabel",
             "created": "2020-09-12T02:11:00Z",
             "group_id": 1474,
             "name": "Meta",
             "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
             "color_name": "sky",
             "color_hex": "#9cc7df"
           }
         ],
         "extra_member_data": [
           {
             "col_id": 48876437,
             "col_type": "text_column",
             "text": "To firstly unlock while host himself me purely as whose."
           },
           {
             "col_id": 161476183,
             "col_type": "paragraph_column",
             "text": "Yet few mustering example will addition yearly since in these."
           },
           {
             "col_id": 39354277,
             "col_type": "checkbox_column",
             "checked": false
           },
           {
             "col_id": 8897324,
             "col_type": "multiple_choice_column",
             "multi_choice": [
               0
             ]
           },
           {
             "col_id": 159828550,
             "col_type": "date_column",
             "date": "1923-10-16T17:57:55.797000001Z"
           },
           {
             "col_id": 185149472,
             "col_type": "time_column",
             "time": "1929-03-30T18:00:36.790929649Z"
           },
           {
             "col_id": 166814414,
             "col_type": "address_column",
             "street_address1": "Premier Medical Group",
             "street_address2": "3701 DAUPHIN ST",
             "city": "MOBILE",
             "state": "AL",
             "zip": "36608-1756",
             "lat": 30.6866076,
             "lng": -88.13019249999999
           },
           {
             "col_id": 102385421,
             "col_type": "multi_choice_column",
             "multi_choice": [
               0,
               1,
               2
             ]
           },
           {
             "col_id": 154317202,
             "col_type": "link_column",
             "title": "To say poorly out according abundant unless nervously string lastly.",
             "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
             "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
           },
           {
             "col_id": 123191768,
             "col_type": "image_column",
             "url": "https://picsum.photos/id/27/187/110",
             "image_name": "Lately blazer with wild hourly there she it infrequently power."
           },
           {
             "col_id": 53386358,
             "col_type": "html_paragraph_column",
             "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
           },
           {
             "col_id": 45812071,
             "col_type": "email_column",
             "text": "brantkozey@bernhard.com"
           }
         ]
       },
       "object": "feed",
       "photos": [
         {
           "id": 960,
           "object": "photo",
           "created": "2020-09-06T23:48:00-07:00",
           "updated": "2022-03-08T08:06:00-08:00",
           "user_id": 147779411,
           "group_id": 8658933,
           "name": "Elegance joy group",
           "desc": "Senegalese whichever happen trade move outside downstairs of exemplified up. Out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for. Her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look.",
           "media_type": "image/jpg",
           "size": 2390440,
           "attachment_num": 0,
           "width": 0,
           "height": 0,
           "album_id": 52691321,
           "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": ""
         }
       ],
       "subgroups": [
         {
           "id": 8658933,
           "object": "group",
           "created": "2020-09-15T11:29:00-07:00",
           "updated": "2022-02-12T18:51:00-08:00",
           "type": "group_type_messages",
           "title": "",
           "name": "StrategyHub",
           "nice_group_name": "",
           "alias": "",
           "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
           "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
           "subject_tag": "[StrategyHub]",
           "footer": "This is my\nFooter!!!!",
           "website": "",
           "announce": false,
           "moderation": "moderated",
           "new_users_moderated": true,
           "unmoderate_users_after": 3,
           "restricted": true,
           "invite_only": false,
           "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_by_members",
           "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,
           "two_factor_policy": "group_2fa_policy_none",
           "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,
           "ai_summaries_enabled": false,
           "sticky_wiki_page_id": 0,
           "sub_group_categoryid": 0,
           "subs_count": 541,
           "pending_subs_count": 0,
           "pending_msgs_count": 0,
           "open_chats_count": 0,
           "threads_count": 0,
           "messages_count": 0,
           "org_domain": "",
           "most_recent_message": "2020-09-07T19:38:00-07: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,
             "ask_visible": 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_reply": 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,
             "can_ask": true
           },
           "email_address": "StrategyHub@groups.io",
           "extra_member_data_columns": [
             {
               "id": 48876437,
               "name": "Text: Lots write point week doctor.",
               "type": "text_column",
               "required": true,
               "color": "color_beige",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Movement whose also it vanish watch these to ever always."
             },
             {
               "id": 161476183,
               "name": "Paragraph: Other few covey range window.",
               "type": "paragraph_column",
               "required": true,
               "color": "color_light_brown",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Silence lastly had what outcome let while school pause up."
             },
             {
               "id": 39354277,
               "name": "Checkbox: Company freedom pout his throw.",
               "type": "checkbox_column",
               "required": true,
               "color": "color_orange",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Quarterly outfit faithful is often part whom these been hourly."
             },
             {
               "id": 8897324,
               "name": "Multiple Choice: Madagascan anyway should late yours.",
               "type": "multiple_choice_column",
               "required": true,
               "color": "color_orchid",
               "choices": [
                 "Monthly ball upon almost everything dynasty.",
                 "Behalf shall nearly this weekly for.",
                 "Anywhere everybody over secondly then boat."
               ],
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Besides pack when murder her had snore first in limp."
             },
             {
               "id": 159828550,
               "name": "Date: Which these bale nobody few.",
               "type": "date_column",
               "required": true,
               "color": "color_blush",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "How anyone these string life that who result lately yourselves."
             },
             {
               "id": 185149472,
               "name": "Time: Besides later whom for rarely.",
               "type": "time_column",
               "required": true,
               "color": "color_sage",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Each her ski ours host our as did they to."
             },
             {
               "id": 166814414,
               "name": "Address: Bravery where this as cloud.",
               "type": "address_column",
               "required": true,
               "color": "color_cucumber",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Inside since open most you that including fight murder cautiously."
             },
             {
               "id": 102385421,
               "name": "Multi Choice: Another what full her can.",
               "type": "multi_choice_column",
               "required": true,
               "color": "color_aquamute",
               "choices": [
                 "Indeed besides motherhood in that nightly.",
                 "Limit we kneel herself collect yourselves.",
                 "Yourselves Norwegian this fear happily fruit."
               ],
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Pout nature bike moreover from whoever afterwards myself mine to."
             },
             {
               "id": 154317202,
               "name": "Link: Bale sedge Christian would whose.",
               "type": "link_column",
               "required": true,
               "color": "color_military",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Hers pack rhythm that now whose her out infancy somebody."
             },
             {
               "id": 123191768,
               "name": "Image: Today scenic consequently ours eye.",
               "type": "image_column",
               "required": true,
               "color": "color_light_grey",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Other other abundant some anywhere this life nevertheless in next."
             },
             {
               "id": 53386358,
               "name": "HTML Paragraph: Nobody what today e.g. loss.",
               "type": "html_paragraph_column",
               "required": true,
               "color": "color_emerald_green",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Spite Philippine before throughout wander of as there next of."
             },
             {
               "id": 45812071,
               "name": "Email: That because am terribly many.",
               "type": "email_column",
               "required": true,
               "color": "color_light_grey",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Because anyone does you hungrily can several might who monthly."
             }
           ]
         }
       ],
       "tables": [
         {
           "add_rows": "database_access_all",
           "columns": [
             {
               "id": 52691321,
               "name": "Multiple Choice: Including tribe anything from whose.",
               "type": "multiple_choice_column",
               "required": true,
               "color": "color_orchid",
               "choices": [
                 "Next each secondly must catch politely.",
                 "Sleepy where i.e. inquisitively yours wisp.",
                 "Regularly nice cackle ourselves heavily now."
               ],
               "width": 0,
               "default_hidden": false,
               "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
             }
           ],
           "created": "2009-11-10T15:00:00-08:00",
           "desc": "",
           "desc_type": "",
           "display_template": "",
           "edit_rows": "database_access_all",
           "edit_table": "database_access_all",
           "group_id": 10,
           "id": 40,
           "id_default_hidden": false,
           "max_col_id": 67,
           "max_row_id": 67,
           "name": "",
           "num_columns": 76,
           "num_rows": 72,
           "object": "databasetable",
           "short_desc": "",
           "updated": "2009-11-10T15:00:00-08:00",
           "updated_default_hidden": false,
           "user_id": 71,
           "view_table": "database_access_all"
         }
       ],
       "topics": [
         {
           "images": [
             {
               "attach_num": 27,
               "content": "",
               "created": "2009-11-10T15:00:00-08:00",
               "group_id": 16,
               "id": "",
               "image_height": 86,
               "image_width": 24,
               "message_num": 34,
               "name": "",
               "object": "attachment",
               "sub_type": "",
               "thread_id": 62,
               "thumbnail_url": "",
               "type": "",
               "user_id": 40
             }
           ],
           "topic": {
             "id": 52691321,
             "object": "topic",
             "created": "2020-09-15T02:30:00-07:00",
             "updated": "2021-03-01T18:07:00-08:00",
             "group_id": 8658933,
             "group_subject_tag": "[StrategyHub]",
             "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
             "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
             "name": "Elenor Schaefer",
             "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": "2020-09-29T17:03:00-07:00",
             "hashtags": null
           }
         }
       ],
       "wikis": [
         {
           "id": 52691321,
           "object": "wiki_page",
           "created": "2020-09-15T02:30:00-07:00",
           "updated": "2021-03-01T18:07:00-08:00",
           "user_id": 147779411,
           "group_id": 8658933,
           "title": "Including tribe anything from whose market",
           "path": "Including-tribe-anything-from-whose-market",
           "locked": false,
           "rev_count": 43
         }
       ]
     }
   ],
   "end_item": 8,
   "has_more": false,
   "next_page_token": 35,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 12,
   "total_count": 64
}

View Feed List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Single Feed#

GET /api/v1/getsinglefeed

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Get a single feed object for a group.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getsinglefeed

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getsinglefeed' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getsinglefeed"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getsinglefeed");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "chats": [
     {
       "id": 52691321,
       "object": "chat",
       "created": "2020-09-15T02:30:00-07:00",
       "updated": "2021-03-01T18:07:00-08:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Including.",
       "desc": "Tribe anything from.",
       "is_closed": false,
       "num_messages": 21,
       "chat_sub": {
         "id": 179889653,
         "object": "chat_sub",
         "created": "2020-09-10T11:42:00-07:00",
         "updated": "2023-03-29T23:48:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 52691321,
         "last_msg_seen": 40
       }
     }
   ],
   "events": [
     {
       "additional_guests": false,
       "all_day": false,
       "color_hex": "",
       "color_name": "color_antique_pink",
       "comment_label": "",
       "created": "2009-11-10T15:00:00-08:00",
       "creator_name": "@JohnSmith",
       "description": "",
       "end_time": "2009-11-10T15:00:00-08:00",
       "group_id": 68,
       "group_name": "",
       "has_rsvp": false,
       "id": 58,
       "location": "",
       "max_attendees": 82,
       "name": "",
       "nice_group_name": "",
       "object": "event",
       "organizer_email": "",
       "organizer_name": "",
       "organizer_phone": "",
       "rsvp": false,
       "rsvp_additional_guests": 65,
       "rsvp_comment": "",
       "rsvp_type": "",
       "show_comments": false,
       "start_time": "2009-11-10T15:00:00-08:00",
       "timezone": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "yes_message": ""
     }
   ],
   "files": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-15T02:30:00-07:00",
       "updated": "2021-03-01T18:07:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ],
   "group": {
     "id": 8658933,
     "object": "group",
     "created": "2020-09-15T11:29:00-07:00",
     "updated": "2022-02-12T18:51:00-08:00",
     "type": "group_type_messages",
     "title": "",
     "name": "StrategyHub",
     "nice_group_name": "",
     "alias": "",
     "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
     "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
     "subject_tag": "[StrategyHub]",
     "footer": "This is my\nFooter!!!!",
     "website": "",
     "announce": false,
     "moderation": "moderated",
     "new_users_moderated": true,
     "unmoderate_users_after": 3,
     "restricted": true,
     "invite_only": false,
     "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_by_members",
     "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,
     "two_factor_policy": "group_2fa_policy_none",
     "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,
     "ai_summaries_enabled": false,
     "sticky_wiki_page_id": 0,
     "sub_group_categoryid": 0,
     "subs_count": 541,
     "pending_subs_count": 0,
     "pending_msgs_count": 0,
     "open_chats_count": 0,
     "threads_count": 0,
     "messages_count": 0,
     "org_domain": "",
     "most_recent_message": "2020-09-07T19:38:00-07: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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "email_address": "StrategyHub@groups.io",
     "extra_member_data_columns": [
       {
         "id": 48876437,
         "name": "Text: Lots write point week doctor.",
         "type": "text_column",
         "required": true,
         "color": "color_beige",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Movement whose also it vanish watch these to ever always."
       },
       {
         "id": 161476183,
         "name": "Paragraph: Other few covey range window.",
         "type": "paragraph_column",
         "required": true,
         "color": "color_light_brown",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Silence lastly had what outcome let while school pause up."
       },
       {
         "id": 39354277,
         "name": "Checkbox: Company freedom pout his throw.",
         "type": "checkbox_column",
         "required": true,
         "color": "color_orange",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Quarterly outfit faithful is often part whom these been hourly."
       },
       {
         "id": 8897324,
         "name": "Multiple Choice: Madagascan anyway should late yours.",
         "type": "multiple_choice_column",
         "required": true,
         "color": "color_orchid",
         "choices": [
           "Monthly ball upon almost everything dynasty.",
           "Behalf shall nearly this weekly for.",
           "Anywhere everybody over secondly then boat."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Besides pack when murder her had snore first in limp."
       },
       {
         "id": 159828550,
         "name": "Date: Which these bale nobody few.",
         "type": "date_column",
         "required": true,
         "color": "color_blush",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "How anyone these string life that who result lately yourselves."
       },
       {
         "id": 185149472,
         "name": "Time: Besides later whom for rarely.",
         "type": "time_column",
         "required": true,
         "color": "color_sage",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Each her ski ours host our as did they to."
       },
       {
         "id": 166814414,
         "name": "Address: Bravery where this as cloud.",
         "type": "address_column",
         "required": true,
         "color": "color_cucumber",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Inside since open most you that including fight murder cautiously."
       },
       {
         "id": 102385421,
         "name": "Multi Choice: Another what full her can.",
         "type": "multi_choice_column",
         "required": true,
         "color": "color_aquamute",
         "choices": [
           "Indeed besides motherhood in that nightly.",
           "Limit we kneel herself collect yourselves.",
           "Yourselves Norwegian this fear happily fruit."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Pout nature bike moreover from whoever afterwards myself mine to."
       },
       {
         "id": 154317202,
         "name": "Link: Bale sedge Christian would whose.",
         "type": "link_column",
         "required": true,
         "color": "color_military",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Hers pack rhythm that now whose her out infancy somebody."
       },
       {
         "id": 123191768,
         "name": "Image: Today scenic consequently ours eye.",
         "type": "image_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Other other abundant some anywhere this life nevertheless in next."
       },
       {
         "id": 53386358,
         "name": "HTML Paragraph: Nobody what today e.g. loss.",
         "type": "html_paragraph_column",
         "required": true,
         "color": "color_emerald_green",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Spite Philippine before throughout wander of as there next of."
       },
       {
         "id": 45812071,
         "name": "Email: That because am terribly many.",
         "type": "email_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Because anyone does you hungrily can several might who monthly."
       }
     ]
   },
   "hashtags": [
     {
       "id": 541,
       "object": "hashtag",
       "created": "2020-09-17T11:22:00-07:00",
       "group_id": 1188,
       "name": "Karl",
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": true,
       "replies_unmoderated": false,
       "locked": true,
       "until": "hashtag_delete_month",
       "close_instead_of_delete": true,
       "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
       "color_name": "pink",
       "color_hex": "#f39de4",
       "reply_to": "thread_reply_to_sender",
       "topic_count": 1789,
       "last_message_date": "2020-09-08T01:22:00-07:00",
       "muted": null,
       "followed": null
     }
   ],
   "member_info": {
     "id": 93846546,
     "object": "member_info",
     "created": "2020-09-09T04:11:00-07:00",
     "updated": "2022-06-08T07:16:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "group_name": "StrategyHub",
     "status": "sub_status_normal",
     "post_status": "sub_poststatus_newusermoderated",
     "email_delivery": "email_delivery_digest",
     "message_selection": "message_selection_follow_and_first_message",
     "auto_follow_replies": false,
     "max_attachment_size": "max_attachment_size_medium",
     "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "profile_privacy": "profile_private",
     "dont_munge_message_id": false,
     "use_signature": false,
     "use_signature_email": false,
     "signature": "In hotel furniture anyone weakly besides",
     "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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "member_labels": [
       {
         "id": 726,
         "object": "memberlabel",
         "created": "2020-09-29T22:19:00Z",
         "group_id": 1857,
         "name": "Florida",
         "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
         "color_name": "green-sage",
         "color_hex": "#9fc4ac"
       },
       {
         "id": 1594,
         "object": "memberlabel",
         "created": "2020-09-24T02:24:00Z",
         "group_id": 42,
         "name": "Russel",
         "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
         "color_name": "purple",
         "color_hex": "#837fd5"
       },
       {
         "id": 1189,
         "object": "memberlabel",
         "created": "2020-09-12T02:11:00Z",
         "group_id": 1474,
         "name": "Meta",
         "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
         "color_name": "sky",
         "color_hex": "#9cc7df"
       }
     ],
     "extra_member_data": [
       {
         "col_id": 48876437,
         "col_type": "text_column",
         "text": "To firstly unlock while host himself me purely as whose."
       },
       {
         "col_id": 161476183,
         "col_type": "paragraph_column",
         "text": "Yet few mustering example will addition yearly since in these."
       },
       {
         "col_id": 39354277,
         "col_type": "checkbox_column",
         "checked": false
       },
       {
         "col_id": 8897324,
         "col_type": "multiple_choice_column",
         "multi_choice": [
           0
         ]
       },
       {
         "col_id": 159828550,
         "col_type": "date_column",
         "date": "1923-10-16T17:57:55.797000001Z"
       },
       {
         "col_id": 185149472,
         "col_type": "time_column",
         "time": "1929-03-30T18:00:36.790929649Z"
       },
       {
         "col_id": 166814414,
         "col_type": "address_column",
         "street_address1": "Premier Medical Group",
         "street_address2": "3701 DAUPHIN ST",
         "city": "MOBILE",
         "state": "AL",
         "zip": "36608-1756",
         "lat": 30.6866076,
         "lng": -88.13019249999999
       },
       {
         "col_id": 102385421,
         "col_type": "multi_choice_column",
         "multi_choice": [
           0,
           1,
           2
         ]
       },
       {
         "col_id": 154317202,
         "col_type": "link_column",
         "title": "To say poorly out according abundant unless nervously string lastly.",
         "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
         "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
       },
       {
         "col_id": 123191768,
         "col_type": "image_column",
         "url": "https://picsum.photos/id/27/187/110",
         "image_name": "Lately blazer with wild hourly there she it infrequently power."
       },
       {
         "col_id": 53386358,
         "col_type": "html_paragraph_column",
         "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
       },
       {
         "col_id": 45812071,
         "col_type": "email_column",
         "text": "brantkozey@bernhard.com"
       }
     ]
   },
   "object": "feed",
   "photos": [
     {
       "id": 960,
       "object": "photo",
       "created": "2020-09-06T23:48:00-07:00",
       "updated": "2022-03-08T08:06:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Elegance joy group",
       "desc": "Senegalese whichever happen trade move outside downstairs of exemplified up. Out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for. Her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look.",
       "media_type": "image/jpg",
       "size": 2390440,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 52691321,
       "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": ""
     }
   ],
   "subgroups": [
     {
       "id": 8658933,
       "object": "group",
       "created": "2020-09-15T11:29:00-07:00",
       "updated": "2022-02-12T18:51:00-08:00",
       "type": "group_type_messages",
       "title": "",
       "name": "StrategyHub",
       "nice_group_name": "",
       "alias": "",
       "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
       "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
       "subject_tag": "[StrategyHub]",
       "footer": "This is my\nFooter!!!!",
       "website": "",
       "announce": false,
       "moderation": "moderated",
       "new_users_moderated": true,
       "unmoderate_users_after": 3,
       "restricted": true,
       "invite_only": false,
       "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_by_members",
       "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,
       "two_factor_policy": "group_2fa_policy_none",
       "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,
       "ai_summaries_enabled": false,
       "sticky_wiki_page_id": 0,
       "sub_group_categoryid": 0,
       "subs_count": 541,
       "pending_subs_count": 0,
       "pending_msgs_count": 0,
       "open_chats_count": 0,
       "threads_count": 0,
       "messages_count": 0,
       "org_domain": "",
       "most_recent_message": "2020-09-07T19:38:00-07: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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "email_address": "StrategyHub@groups.io",
       "extra_member_data_columns": [
         {
           "id": 48876437,
           "name": "Text: Lots write point week doctor.",
           "type": "text_column",
           "required": true,
           "color": "color_beige",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Movement whose also it vanish watch these to ever always."
         },
         {
           "id": 161476183,
           "name": "Paragraph: Other few covey range window.",
           "type": "paragraph_column",
           "required": true,
           "color": "color_light_brown",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Silence lastly had what outcome let while school pause up."
         },
         {
           "id": 39354277,
           "name": "Checkbox: Company freedom pout his throw.",
           "type": "checkbox_column",
           "required": true,
           "color": "color_orange",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Quarterly outfit faithful is often part whom these been hourly."
         },
         {
           "id": 8897324,
           "name": "Multiple Choice: Madagascan anyway should late yours.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Monthly ball upon almost everything dynasty.",
             "Behalf shall nearly this weekly for.",
             "Anywhere everybody over secondly then boat."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Besides pack when murder her had snore first in limp."
         },
         {
           "id": 159828550,
           "name": "Date: Which these bale nobody few.",
           "type": "date_column",
           "required": true,
           "color": "color_blush",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "How anyone these string life that who result lately yourselves."
         },
         {
           "id": 185149472,
           "name": "Time: Besides later whom for rarely.",
           "type": "time_column",
           "required": true,
           "color": "color_sage",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Each her ski ours host our as did they to."
         },
         {
           "id": 166814414,
           "name": "Address: Bravery where this as cloud.",
           "type": "address_column",
           "required": true,
           "color": "color_cucumber",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Inside since open most you that including fight murder cautiously."
         },
         {
           "id": 102385421,
           "name": "Multi Choice: Another what full her can.",
           "type": "multi_choice_column",
           "required": true,
           "color": "color_aquamute",
           "choices": [
             "Indeed besides motherhood in that nightly.",
             "Limit we kneel herself collect yourselves.",
             "Yourselves Norwegian this fear happily fruit."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Pout nature bike moreover from whoever afterwards myself mine to."
         },
         {
           "id": 154317202,
           "name": "Link: Bale sedge Christian would whose.",
           "type": "link_column",
           "required": true,
           "color": "color_military",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Hers pack rhythm that now whose her out infancy somebody."
         },
         {
           "id": 123191768,
           "name": "Image: Today scenic consequently ours eye.",
           "type": "image_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Other other abundant some anywhere this life nevertheless in next."
         },
         {
           "id": 53386358,
           "name": "HTML Paragraph: Nobody what today e.g. loss.",
           "type": "html_paragraph_column",
           "required": true,
           "color": "color_emerald_green",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Spite Philippine before throughout wander of as there next of."
         },
         {
           "id": 45812071,
           "name": "Email: That because am terribly many.",
           "type": "email_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Because anyone does you hungrily can several might who monthly."
         }
       ]
     }
   ],
   "tables": [
     {
       "add_rows": "database_access_all",
       "columns": [
         {
           "id": 52691321,
           "name": "Multiple Choice: Including tribe anything from whose.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Next each secondly must catch politely.",
             "Sleepy where i.e. inquisitively yours wisp.",
             "Regularly nice cackle ourselves heavily now."
           ],
           "width": 0,
           "default_hidden": false,
           "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
         }
       ],
       "created": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "desc_type": "",
       "display_template": "",
       "edit_rows": "database_access_all",
       "edit_table": "database_access_all",
       "group_id": 89,
       "id": 87,
       "id_default_hidden": false,
       "max_col_id": 84,
       "max_row_id": 32,
       "name": "",
       "num_columns": 34,
       "num_rows": 10,
       "object": "databasetable",
       "short_desc": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "updated_default_hidden": false,
       "user_id": 62,
       "view_table": "database_access_all"
     }
   ],
   "topics": [
     {
       "images": [
         {
           "attach_num": 88,
           "content": "",
           "created": "2009-11-10T15:00:00-08:00",
           "group_id": 88,
           "id": "",
           "image_height": 7,
           "image_width": 69,
           "message_num": 86,
           "name": "",
           "object": "attachment",
           "sub_type": "",
           "thread_id": 41,
           "thumbnail_url": "",
           "type": "",
           "user_id": 70
         }
       ],
       "topic": {
         "id": 52691321,
         "object": "topic",
         "created": "2020-09-15T02:30:00-07:00",
         "updated": "2021-03-01T18:07:00-08:00",
         "group_id": 8658933,
         "group_subject_tag": "[StrategyHub]",
         "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
         "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
         "name": "Elenor Schaefer",
         "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": "2020-09-29T17:03:00-07:00",
         "hashtags": null
       }
     }
   ],
   "wikis": [
     {
       "id": 52691321,
       "object": "wiki_page",
       "created": "2020-09-15T02:30:00-07:00",
       "updated": "2021-03-01T18:07:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "Including tribe anything from whose market",
       "path": "Including-tribe-anything-from-whose-market",
       "locked": false,
       "rev_count": 43
     }
   ]
}

View Feed definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Files

These are the API endpoints for directories and files.

Add Files#

POST /api/v1/addfiles

Authentication: Bearer API key, Basic token, or session cookie Request: multipart/form-data Response: application/json

Permissions:

You must have permission to add files to the folder.

Add files or a folder of files.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
parent_folder_id required integer	ID of the folder to add the files to, or 0 if the top-level.
desc optional string	Description of the file or of the folder.
fileupload required multipart file	Multipart file upload of one or more files.
is_folder optional boolean	If `true`, this is an upload of a folder.
file_path optional strings	If `is_folder` is true, for each file there should be a `file_path` variable, specifying the path of the file within the directory being uploaded.
notify optional boolean	If `true`, send a notification to the group.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

"bad_request"	"invalid folder_id" is returned if the folder id is missing or invalid.
"bad_request"	"no space" is returned if the group is out of space.
"bad_request"	"file too big" is returned if the file is too large.
"bad_request"	"images not allowed" is returned if an image is uploaded to the files section of the group that does not allow images in the files section.
"bad_request"	"duplicate file" is returned if the name of the file matches another file in the same folder.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/addfiles

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/addfiles' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --form-string 'group_id=12' \
  --form-string 'parent_folder_id=0' \
  --form 'fileupload=@/path/to/document.pdf'

package main

import (
    "bytes"
    "fmt"
    "io"
    "mime/multipart"
    "net/http"
    "os"
    "path/filepath"
)

func main() {
    var requestBody bytes.Buffer
    writer := multipart.NewWriter(&requestBody)
    if err := writer.WriteField("group_id", "12"); err != nil {
        panic(err)
    }
    if err := writer.WriteField("parent_folder_id", "0"); err != nil {
        panic(err)
    }
    {
        file, err := os.Open("/path/to/document.pdf")
        if err != nil {
            panic(err)
        }
        part, err := writer.CreateFormFile("fileupload", filepath.Base(file.Name()))
        if err != nil {
            file.Close()
            panic(err)
        }
        _, err = io.Copy(part, file)
        file.Close()
        if err != nil {
            panic(err)
        }
    }
    if err := writer.Close(); err != nil {
        panic(err)
    }
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/addfiles", &requestBody)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", writer.FormDataContentType())
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const { readFile } = await import('node:fs/promises');
    const url = new URL("https://groups.io/api/v1/addfiles");
    const body = new FormData();
    body.append("group_id", "12");
    body.append("parent_folder_id", "0");
    body.append("fileupload", new Blob([await readFile("/path/to/document.pdf")]), "document.pdf");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "file",
       "created": "2020-09-29T17:03:00-07:00",
       "updated": "2022-06-18T23:30:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Lilly Block",
       "desc": "Few why where win most would everybody them backwards this.",
       "size": 98233877,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/189377967/Lilly%20Block?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=chfSbllg5MQwy7qtUhBhVLtETTo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 175712125,
       "object": "file",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Ludwig Douglas",
       "desc": "Mine year is ever what flock jealousy inside pod without.",
       "size": 197424827,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/175712125/Ludwig%20Douglas?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=t3jCZ652kdCBVtZ2PZEod8oFi4I%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}

View File List definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid folder_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no space"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "file too big"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "images not allowed"
}

"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.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "duplicate file"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Add Link#

POST /api/v1/addfilelink

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have permission to add a link to the folder.

Add file link.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
link_type required string	Type of the link. Can be: `google`, `dropbox`, `box`, `onedrive`, `generic`.
file_name required string	Name of the link.
url required string	The URL.
parent_folder_id required integer	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 `true`, send a notification to the group.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/addfilelink

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/addfilelink' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'parent_folder_id=0' \
  --data-urlencode 'link_type=generic' \
  --data-urlencode 'file_name=Example' \
  --data-urlencode 'url=https://example.com/'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("parent_folder_id", "0")
    params.Add("link_type", "generic")
    params.Add("file_name", "Example")
    params.Add("url", "https://example.com/")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/addfilelink", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/addfilelink");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("parent_folder_id", "0");
    body.append("link_type", "generic");
    body.append("file_name", "Example");
    body.append("url", "https://example.com/");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "file",
       "created": "2020-09-29T17:03:00-07:00",
       "updated": "2022-06-18T23:30:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Lilly Block",
       "desc": "Few why where win most would everybody them backwards this.",
       "size": 98233877,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/189377967/Lilly%20Block?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=chfSbllg5MQwy7qtUhBhVLtETTo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 175712125,
       "object": "file",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Ludwig Douglas",
       "desc": "Mine year is ever what flock jealousy inside pod without.",
       "size": 197424827,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/175712125/Ludwig%20Douglas?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=t3jCZ652kdCBVtZ2PZEod8oFi4I%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}

View File List definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid url"
}

"invalid url" is returned if the URL is missing or invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid file_name"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid parent_folder_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "duplicate file"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get File Directory#

GET /api/v1/getfiledirectory

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getfiledirectory

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getfiledirectory' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'path=/Top/Next'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("path", "/Top/Next")
    endpoint := "https://groups.io/api/v1/getfiledirectory"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getfiledirectory");
    url.searchParams.append("group_id", "12");
    url.searchParams.append("path", "/Top/Next");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "file",
       "created": "2020-09-29T17:03:00-07:00",
       "updated": "2022-06-18T23:30:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Lilly Block",
       "desc": "Few why where win most would everybody them backwards this.",
       "size": 98233877,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/189377967/Lilly%20Block?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=chfSbllg5MQwy7qtUhBhVLtETTo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 175712125,
       "object": "file",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Ludwig Douglas",
       "desc": "Mine year is ever what flock jealousy inside pod without.",
       "size": 197424827,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/175712125/Ludwig%20Douglas?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=t3jCZ652kdCBVtZ2PZEod8oFi4I%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}

View File List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get File#

GET /api/v1/getfile

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get file.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
path required string	Path to file to download.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getfile

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getfile' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getfile"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getfile");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 52691321,
   "object": "file",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "name": "Kelsi Ledner",
   "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
   "size": 132787700,
   "path": "topfolder/subfolder",
   "parent_folder_id": 0,
   "type": "file_type_file",
   "count": 2,
   "media_type": "text/plain",
   "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@..."
}

View File definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Search Files#

GET /api/v1/searchfiles

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/searchfiles

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/searchfiles' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'q=Search Term'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("q", "Search Term")
    endpoint := "https://groups.io/api/v1/searchfiles"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/searchfiles");
    url.searchParams.append("group_id", "12");
    url.searchParams.append("q", "Search Term");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "file",
       "created": "2020-09-29T17:03:00-07:00",
       "updated": "2022-06-18T23:30:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Lilly Block",
       "desc": "Few why where win most would everybody them backwards this.",
       "size": 98233877,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/189377967/Lilly%20Block?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=chfSbllg5MQwy7qtUhBhVLtETTo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 175712125,
       "object": "file",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Ludwig Douglas",
       "desc": "Mine year is ever what flock jealousy inside pod without.",
       "size": 197424827,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/175712125/Ludwig%20Douglas?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=t3jCZ652kdCBVtZ2PZEod8oFi4I%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}

View File List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid query"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete File#

POST /api/v1/deletefile

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have permission to edit a file.

Delete file.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
file_id required integer	ID of the file to delete.
notify optional boolean	If `true`, send a notification to the group.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

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.
"bad_request"	"file not found" is returned if the file has already been deleted.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletefile

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletefile' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'file_id=34'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("file_id", "34")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletefile", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletefile");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("file_id", "34");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "file",
       "created": "2020-09-29T17:03:00-07:00",
       "updated": "2022-06-18T23:30:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Lilly Block",
       "desc": "Few why where win most would everybody them backwards this.",
       "size": 98233877,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/189377967/Lilly%20Block?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=chfSbllg5MQwy7qtUhBhVLtETTo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 175712125,
       "object": "file",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Ludwig Douglas",
       "desc": "Mine year is ever what flock jealousy inside pod without.",
       "size": 197424827,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/175712125/Ludwig%20Douglas?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=t3jCZ652kdCBVtZ2PZEod8oFi4I%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}

View File List definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid url"
}

"invalid url" is returned if the URL is missing or invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid file_name"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid parent_folder_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "duplicate file"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "file not found"
}

"file not found" is returned if the file has already been deleted.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Group

Create Group#

POST /api/v1/creategroup

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

None.

Create a group.

POST Parameters

group_name required string	Name of the new group.
desc required string	Description of the new group.
privacy required string	Privacy of the new group, one of `group_privacy_none`, `group_privacy_archives`, `group_privacy_unlisted`, `group_privacy_unlisted_public`
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
accept_policies required boolean	Signals that you agree to comply with our Online Safety Policy and our Terms of Service. This must be set to `true`.
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/creategroup

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/creategroup' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_name=apisubgroup' \
  --data-urlencode 'desc=This is my group' \
  --data-urlencode 'privacy=group_privacy_none'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_name", "apisubgroup")
    params.Add("desc", "This is my group")
    params.Add("privacy", "group_privacy_none")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/creategroup", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/creategroup");
    const body = new URLSearchParams();
    body.append("group_name", "apisubgroup");
    body.append("desc", "This is my group");
    body.append("privacy", "group_privacy_none");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

View Group definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_name"
}

"invalid group_name" is returned if the group name is not a valid group name.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "description too short"
}

"description too short" is returned if the group description is too short.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "name already taken"
}

"name already taken" is returned if a group with that name already exists.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Create Sub Group#

POST /api/v1/createsubgroup

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the manage_subgroups permission to use this call.

Create a subgroup.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
sub_group_name required string	Name of the new subgroup
desc required string	Description of the new subgroup
privacy required string	Privacy of the new subgroup, one of `sub_group_privacy_limited_archives`, `sub_group_privacy_archives`, `sub_group_privacy_unlisted`, `sub_group_privacy_none`
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
accept_policies required boolean	Signals that you agree to comply with our Online Safety Policy and our Terms of Service. This must be set to `true`.
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/createsubgroup

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/createsubgroup' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=5' \
  --data-urlencode 'sub_group_name=apisubgroup' \
  --data-urlencode 'desc=This is my subgroup' \
  --data-urlencode 'privacy=sub_group_privacy_none' \
  --data-urlencode 'accept_policies=true'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "5")
    params.Add("sub_group_name", "apisubgroup")
    params.Add("desc", "This is my subgroup")
    params.Add("privacy", "sub_group_privacy_none")
    params.Add("accept_policies", "true")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/createsubgroup", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/createsubgroup");
    const body = new URLSearchParams();
    body.append("group_id", "5");
    body.append("sub_group_name", "apisubgroup");
    body.append("desc", "This is my subgroup");
    body.append("privacy", "sub_group_privacy_none");
    body.append("accept_policies", "true");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

View Group definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_name"
}

"invalid group_name" is returned if the group name is not a valid group nae.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "description too short"
}

"description too short" is returned if the subgroup description is too short.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "name already taken"
}

"name already taken" is returned if a subgroup with that name already exists.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "group is a subgroup"
}

"group is a subgroup" is returned if the group_id refers to a subgroup and not a parent group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "group does not support subgroups"
}

"group does not support subgroups" is returned if the group is a free group.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Group Settings#

GET /api/v1/getgroup

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get the group settings

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified, but `group_id` will be ignored if you are not subscribed to the group.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified, but `group_id` will be ignored if you are not subscribed to the group.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Additional Errors

	A `not_subscribed` error is returned if you specify a `group_id` for a group that you are not subscribed to.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getgroup

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getgroup' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=7'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "7")
    endpoint := "https://groups.io/api/v1/getgroup"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getgroup");
    url.searchParams.append("group_id", "7");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

View Group definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Sub Groups#

GET /api/v1/getsubgroups

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must have the manage_group_settings permission to use this call.

Get a group's subgroups.

Query Parameters

group_id conditional integer	ID of the parent group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the parent group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `created`, `name`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getsubgroups

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getsubgroups' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=5'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "5")
    endpoint := "https://groups.io/api/v1/getsubgroups"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getsubgroups");
    url.searchParams.append("group_id", "5");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 8658933,
       "object": "group",
       "created": "2020-09-15T11:29:00-07:00",
       "updated": "2022-02-12T18:51:00-08:00",
       "type": "group_type_messages",
       "title": "",
       "name": "StrategyHub",
       "nice_group_name": "",
       "alias": "",
       "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
       "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
       "subject_tag": "[StrategyHub]",
       "footer": "This is my\nFooter!!!!",
       "website": "",
       "announce": false,
       "moderation": "moderated",
       "new_users_moderated": true,
       "unmoderate_users_after": 3,
       "restricted": true,
       "invite_only": false,
       "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_by_members",
       "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,
       "two_factor_policy": "group_2fa_policy_none",
       "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,
       "ai_summaries_enabled": false,
       "sticky_wiki_page_id": 0,
       "sub_group_categoryid": 0,
       "subs_count": 541,
       "pending_subs_count": 0,
       "pending_msgs_count": 0,
       "open_chats_count": 0,
       "threads_count": 0,
       "messages_count": 0,
       "org_domain": "",
       "most_recent_message": "2020-09-07T19:38:00-07: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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "email_address": "StrategyHub@groups.io",
       "extra_member_data_columns": [
         {
           "id": 48876437,
           "name": "Text: Lots write point week doctor.",
           "type": "text_column",
           "required": true,
           "color": "color_beige",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Movement whose also it vanish watch these to ever always."
         },
         {
           "id": 161476183,
           "name": "Paragraph: Other few covey range window.",
           "type": "paragraph_column",
           "required": true,
           "color": "color_light_brown",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Silence lastly had what outcome let while school pause up."
         },
         {
           "id": 39354277,
           "name": "Checkbox: Company freedom pout his throw.",
           "type": "checkbox_column",
           "required": true,
           "color": "color_orange",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Quarterly outfit faithful is often part whom these been hourly."
         },
         {
           "id": 8897324,
           "name": "Multiple Choice: Madagascan anyway should late yours.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Monthly ball upon almost everything dynasty.",
             "Behalf shall nearly this weekly for.",
             "Anywhere everybody over secondly then boat."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Besides pack when murder her had snore first in limp."
         },
         {
           "id": 159828550,
           "name": "Date: Which these bale nobody few.",
           "type": "date_column",
           "required": true,
           "color": "color_blush",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "How anyone these string life that who result lately yourselves."
         },
         {
           "id": 185149472,
           "name": "Time: Besides later whom for rarely.",
           "type": "time_column",
           "required": true,
           "color": "color_sage",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Each her ski ours host our as did they to."
         },
         {
           "id": 166814414,
           "name": "Address: Bravery where this as cloud.",
           "type": "address_column",
           "required": true,
           "color": "color_cucumber",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Inside since open most you that including fight murder cautiously."
         },
         {
           "id": 102385421,
           "name": "Multi Choice: Another what full her can.",
           "type": "multi_choice_column",
           "required": true,
           "color": "color_aquamute",
           "choices": [
             "Indeed besides motherhood in that nightly.",
             "Limit we kneel herself collect yourselves.",
             "Yourselves Norwegian this fear happily fruit."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Pout nature bike moreover from whoever afterwards myself mine to."
         },
         {
           "id": 154317202,
           "name": "Link: Bale sedge Christian would whose.",
           "type": "link_column",
           "required": true,
           "color": "color_military",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Hers pack rhythm that now whose her out infancy somebody."
         },
         {
           "id": 123191768,
           "name": "Image: Today scenic consequently ours eye.",
           "type": "image_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Other other abundant some anywhere this life nevertheless in next."
         },
         {
           "id": 53386358,
           "name": "HTML Paragraph: Nobody what today e.g. loss.",
           "type": "html_paragraph_column",
           "required": true,
           "color": "color_emerald_green",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Spite Philippine before throughout wander of as there next of."
         },
         {
           "id": 45812071,
           "name": "Email: That because am terribly many.",
           "type": "email_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Because anyone does you hungrily can several might who monthly."
         }
       ]
     }
   ],
   "end_item": 46,
   "has_more": false,
   "next_page_token": 42,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 89,
   "total_count": 11
}

View Group List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Group#

POST /api/v1/updategroup

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the manage_group_settings permission to use this call.

Update a group's settings.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
title optional string	Title.
name optional string	New name for the group. If this is a subgroup, this needs to be of the form `parentName+subName`.
alias optional string	Alias.
desc optional string	Description.
subject_tag optional string	Subject tag.
footer optional string	Message footer.
website optional string	Website.
announce optional boolean
moderated optional boolean
new_users_moderated optional boolean
unmoderate_users_after optional number
restricted optional boolean
allow_non_subs_to_post optional boolean
force_html_emails optional boolean
normalize_html_emails optional boolean
reply_to optional string	Can be `group_reply_to_group`, `group_reply_to_sender`, `group_reply_to_moderators`, `group_reply_to_group_and_sender`
remove_other_reply_options optional boolean
privacy optional string	For a parent/stand alone group, can be `group_privacy_none`, `group_privacy_archives`, `group_privacy_unlisted`, `group_privacy_unlisted_public`. For a subgroup, can be `sub_group_privacy_limited_archives`, `sub_group_privacy_archives`, `sub_group_privacy_unlisted`, `sub_group_privacy_none`, `sub_group_privacy_unlisted_public_archives`.
members_visible optional string	Can be `group_view_members_subs`, `group_view_members_moderators`, `group_view_members_owners`
sub_group_access optional string	Who has permission to create sub groups. For groups with subgroups, only settable on the parent group. Possible values are: `sub_group_subs`, `sub_group_moderators`,`sub_group_owners`
calendar_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`
files_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`
database_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`
wiki_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`, `group_access_public`, `group_access_public_limited`
photos_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_moderators_only`, `group_access_none`
member_directory_access optional string	Can be `group_access_limited`, `group_access_moderators_only`, `group_access_none`
polls_access optional string	Can be `polls_access_subscribers`, `polls_access_limited`, `polls_access_none`
chat_access optional string	Can be `group_access_limited`, `group_access_subscribers`, `group_access_none`
handle_attachments optional string	Can be `group_attachments_normal`, `group_attachments_bounced`, `group_attachments_stripped`, `group_attachments_moderated`
handle_virus optional string	Can be: `handle_virus_block`, `handle_virus_moderate`
plain_text_only optional boolean
fig_leaf optional string	Can be `fig_leaf_archives`, `fig_leaf_none`
max_photo_size_email optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
max_photo_size_photos optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
max_photo_size_databases optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
max_photo_size_wiki_images optional string	Can be `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_medium`, `max_photo_size_large`, `max_photo_size_ex_small`, `max_photo_size_medium_small`, `max_photo_size_somewhat_small`
hash_tags_required optional boolean
hash_tag_permissions optional string	Can be: `hash_tag_create_subs`, `hash_tag_create_mods_bounce`, `hash_tag_create_mods_remove`
bounce_attachments optional boolean
allow_photos_in_files optional boolean
email_delivery_default optional string	Email delivery default, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection_default optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies_default optional boolean
max_attachment_size_default optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
default_color optional string	Default color for member subscriptions.
default_timezone optional string	Default timezone for new users. For groups with subgroups, only settable on the parent group. The timezone string should corresponding to a file in the IANA Time Zone database.
disable_edits optional boolean
disable_no_email optional boolean
auto_close_threads optional boolean
close_threads_after optional number
auto_moderate_threads optional boolean
moderate_threads_after optional number
allow_reposts optional boolean	If true, members can repost messages. Only used with premium and enterprise groups.
min_days_between_reposts optional number	The minimum number of days between reposts.
max_number_of_reposts optional number	The maximum number of times a member can repost their message.
allow_parent_subs_to_post optional boolean
send_event_summaries optional boolean	If `true`, and a premium group, a summary email of upcoming events is sent out regularly.
event_summary_schedule optional string	Can be `event_summary_weekly_friday`, `event_summary_monthly`, `event_summary_biweekly_friday`.
send_invites_on_join optional boolean	If `true`, and a premium group, invites to all calendar events will be sent to new users, and a set of cancel events will be sent to users when they leave.
lock_group optional boolean	If `true`, and a premium group, locks the group, preventing any additional changes.
extra_member_data_columns optional string (JSON array)	JSON array of Database Column Objects. Each column object can include `id` (omit or set to 0 for new columns), `name`, `type`, `required`, `choices`, `width`, `default_hidden`, `profile`, `description`, `default_country`, and address exclusion fields. Columns not included in the array will be removed. Requires a non-Basic plan.
subgroup_allowed_tier_ids optional string repeated field	Array of parent membership-tier IDs allowed to join this subgroup (paid memberships). Only valid on a subgroup whose parent has paid memberships enabled, and requires the `manage_paid_subscriptions` permission on the parent group. An explicit empty value means open to every tier; a non-empty list restricts joining to exactly those tiers (`0` is the free default tier). Existing members are grandfathered (kept) unless `remove_nonqualifying` is `true`.
remove_nonqualifying optional boolean	Only used with `subgroup_allowed_tier_ids`. When `true`, current subgroup members whose parent tier the new list excludes (subgroup moderators/owners aside) are removed immediately; when omitted or `false`, they are grandfathered.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

bad_request	"name exists" is returned if the group name is already taken.
bad_request	"invalid group_name" is returned if it's a bad group name.
bad_request	"invalid extra_member_data_columns" is returned if the extra_member_data_columns JSON is malformed or contains invalid values.
bad_request	"subgroup_allowed_tier_ids" is returned if a submitted tier ID is not a live tier of the parent group, or a value is not a number.
invalid_request	"subgroup_allowed_tier_ids" is returned if the field is sent for a non-subgroup; "paid memberships not enabled" is returned if the parent has paid memberships disabled.
	inadequate_permissions is returned if `subgroup_allowed_tier_ids` is sent without the `manage_paid_subscriptions` permission on the parent group.

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updategroup

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updategroup' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=2' \
  --data-urlencode 'chat_access=group_access_limited'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "2")
    params.Add("chat_access", "group_access_limited")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updategroup", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updategroup");
    const body = new URLSearchParams();
    body.append("group_id", "2");
    body.append("chat_access", "group_access_limited");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

View Group definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Group#

POST /api/v1/deletegroup

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must have the delete_group permission to use this call.

Delete a group or a subgroup.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
understand required string	The string "I understand".
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
reason optional string	A reason for deleting the group.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletegroup

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletegroup' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=2' \
  --data-urlencode 'understand=I understand'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "2")
    params.Add("understand", "I understand")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletegroup", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletegroup");
    const body = new URLSearchParams();
    body.append("group_id", "2");
    body.append("understand", "I understand");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

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

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Permissions#

GET /api/v1/getperms

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

None.

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.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getperms

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getperms' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=7'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "7")
    endpoint := "https://groups.io/api/v1/getperms"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getperms");
    url.searchParams.append("group_id", "7");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "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,
   "ask_visible": 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_reply": 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,
   "can_ask": true
}

View Perms definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Extra Member Column Def#

POST /api/v1/updateextramembercolumndef

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the manage_group_settings permission to use this call. Requires a non-Basic plan.

Update a single extra member data column definition on a group. This allows modifying properties of a column (name, choices, description, etc.) without sending the full columns array.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
column_id required integer	ID of the extra member data column to update. Column IDs can be found in the `extra_member_data_columns` array of the group object, in each column's `id` field.
name optional string	The column name.
type optional string	The column type. See the `type` field of the database column object for valid values.
description optional string	The column description.
required optional boolean	Whether the column is required.
choices optional string (JSON array)	JSON array of choice strings for `multiple_choice` or `multi_choice` columns. E.g. `["Option A","Option B","Option C"]`. Only valid for `multiple_choice_column` and `multi_choice_column` types.
width optional number	The column width (0 for default).
default_hidden optional boolean	Whether the column is hidden by default.
profile optional boolean	Whether the column is part of a member's profile.
color optional string	The column color. See the `color` field of the database column object for valid values.
default_country optional string	For address columns, the default country.
exclude_street optional boolean	For address columns, exclude street fields.
exclude_city optional boolean	For address columns, exclude the city field.
exclude_state optional boolean	For address columns, exclude the state field.
exclude_zip optional boolean	For address columns, exclude the zip field.
exclude_country optional boolean	For address columns, exclude the country field.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

Returns the group object if the update succeeded. Returns an error if parameters are invalid.

Additional Errors

bad_request	"column_id required" is returned if column_id is not provided.
bad_request	"invalid column_id" is returned if column_id is not a valid number.
bad_request	"column not found" is returned if the specified column does not exist in the group.
bad_request	"requires non-basic plan" is returned if the group is on the Basic plan.
bad_request	"choices only valid for multiple_choice or multi_choice columns" is returned if choices are specified for a non-choice column type.
bad_request	"invalid choices, expected JSON array of strings" is returned if the choices JSON is malformed.
bad_request	"invalid column type" is returned if an invalid type value is provided.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updateextramembercolumndef

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updateextramembercolumndef' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=2' \
  --data-urlencode 'column_id=1' \
  --data-urlencode 'choices=["Bronze","Silver","Gold"]'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "2")
    params.Add("column_id", "1")
    params.Add("choices", "[\"Bronze\",\"Silver\",\"Gold\"]")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updateextramembercolumndef", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updateextramembercolumndef");
    const body = new URLSearchParams();
    body.append("group_id", "2");
    body.append("column_id", "1");
    body.append("choices", "[\"Bronze\",\"Silver\",\"Gold\"]");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

View Group definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Group Aliases#

GET /api/v1/getgroupaliases

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must have the manage_group_settings permission to use this call.

Get a group's aliases.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `created`, `name`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getgroupaliases

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getgroupaliases' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=5'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "5")
    endpoint := "https://groups.io/api/v1/getgroupaliases"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getgroupaliases");
    url.searchParams.append("group_id", "5");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "alias_group_id": 38,
       "created": "2009-11-10T15:00:00-08:00",
       "id": 75,
       "name": "example",
       "object": "groupalias",
       "updated": "2009-11-10T15:00:00-08:00"
     }
   ],
   "end_item": 10,
   "has_more": false,
   "next_page_token": 23,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 1,
   "total_count": 87
}

View Group Alias List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Add New Group Alias#

POST /api/v1/newgroupalias

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Add a new group alias.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
alias_name required string	Name of the alias to create.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

bad_request	"invalid alias_name" is returned if the alias name is not a valid group name.
bad_request	"basic group" is returned if the group is not a premium or enterprise group.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newgroupalias

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newgroupalias' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=65' \
  --data-urlencode 'alias_name=newalias'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "65")
    params.Add("alias_name", "newalias")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newgroupalias", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newgroupalias");
    const body = new URLSearchParams();
    body.append("group_id", "65");
    body.append("alias_name", "newalias");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

View Group definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Group Alias#

POST /api/v1/deletegroupalias

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the manage_group_settings permission to use this call.

Delete a group alias.

POST Parameters

alias_group_id conditional integer	ID of the alias group object to delete. Either `alias_group_id` or `alias_group_name` must be specified.
alias_group_name conditional string	Name of the alias group object to delete. Either `alias_group_id` or `alias_group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

bad_request	"invalid alias_group_name" is returned if the alias name is not a valid alias.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletegroupalias

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletegroupalias' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'alias_group_id=65'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("alias_group_id", "65")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletegroupalias", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletegroupalias");
    const body = new URLSearchParams();
    body.append("alias_group_id", "65");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

View Group definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Hashtags

New Hashtag#

POST /api/v1/newhashtag

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Create a new hashtag.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
name required string	Name of the hashtag, should begin with #.
description optional string	Description of the hashtag.
no_email optional boolean	If `true`, messages with this tag will not be emailed to the group.
reply_to required string	How replies to these messages are handled. Can be one of: `thread_reply_group_default`, `thread_reply_to_group`, `thread_reply_to_sender`, `thread_reply_to_moderators`, `thread_reply_to_group_and_sender`, `thread_reply_only_to_sender`
until required string	When set, tagged topics will automatically be deleted or locked after the specified time period. Can be one of: `hashtag_delete_forever`, `hashtag_delete_hour`, `hashtag_delete_day`, `hashtag_delete_week`, `hashtag_delete_month`, `hashtag_delete_three_months`, `hashtag_delete_six_months`, `hashtag_delete_year`
color required string	Color of the tag. Use a color name listed in the `color_name` field of the hashtag object.
mods_only_post optional boolean	If `true`, only moderators can tag topics with this hashtag.
mods_only_replies optional boolean	If `true`, only moderators can reply to topics tagged with this hashtag.
close_instead optional boolean	If `true`, topics will be locked instead of deleted after the specified time period.
moderated optional boolean	If `true`, messages with this hashtag will be moderated.
locked optional boolean	If `true`, topics created with this hashtag will be locked immediately.
alias optional string	If specified, this hashtag is an alias of the named hashtag.
replies_unmoderated optional boolean	In moderated groups, if this is `true` replies to these messages are not moderated.
special optional boolean	If `true`, messages with this tag will be sent as special notices.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid name" is returned if the name is missing or invalid.
"bad_request"	"name exists" is returned if a hashtag with that name already exists.
"bad_request"	"invalid reply_to" is returned if the reply_to is missing or invalid.
"bad_request"	"invalid until" is returned if the until is missing or invalid.
"bad_request"	"invalid color" is returned if the color is missing or invalid.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newhashtag

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newhashtag' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'name=#Test'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("name", "#Test")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newhashtag", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newhashtag");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("name", "#Test");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 541,
   "object": "hashtag",
   "created": "2020-09-17T11:22:00-07:00",
   "group_id": 1188,
   "name": "Karl",
   "mods_only_post": false,
   "mods_only_replies": false,
   "no_email": false,
   "moderated": false,
   "special": true,
   "replies_unmoderated": false,
   "locked": true,
   "until": "hashtag_delete_month",
   "close_instead_of_delete": true,
   "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
   "color_name": "pink",
   "color_hex": "#f39de4",
   "reply_to": "thread_reply_to_sender",
   "topic_count": 1789,
   "last_message_date": "2020-09-08T01:22:00-07:00",
   "muted": null,
   "followed": null
}

View Hashtag definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "name exists"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid reply_to"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid until"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid color"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Hashtag#

POST /api/v1/updatehashtag

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Update an existing hashtag.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
name required string	Name of the hashtag, should begin with #.
new_name optional string	New name of the hashtag, should begin with #.
description optional string	Description of the hashtag.
no_email optional boolean	If `true`, messages with this tag will not be emailed to the group.
reply_to optional string	How replies to these messages are handled. Can be one of: `thread_reply_group_default`, `thread_reply_to_group`, `thread_reply_to_sender`, `thread_reply_to_moderators`, `thread_reply_to_group_and_sender`, `thread_reply_only_to_sender`
until optional string	When set, tagged topics will automatically be deleted or locked after the specified time period. Can be one of: `hashtag_delete_forever`, `hashtag_delete_hour`, `hashtag_delete_day`, `hashtag_delete_week`, `hashtag_delete_month`, `hashtag_delete_three_months`, `hashtag_delete_six_months`, `hashtag_delete_year`
color optional string	Color of the tag. Use a color name listed in the `color_name` field of the hashtag object.
mods_only_post optional boolean	If `true`, only moderators can tag topics with this hashtag.
mods_only_replies optional boolean	If `true`, only moderators can reply to topics tagged with this hashtag.
close_instead optional boolean	If `true`, topics will be locked instead of deleted after the specified time period.
moderated optional boolean	If `true`, messages with this hashtag will be moderated.
locked optional boolean	If `true`, topics created with this hashtag will be locked immediately.
alias optional string	If specified, this hashtag is an alias of the named hashtag.
replies_unmoderated optional boolean	In moderated groups, if this is `true` replies to these messages are not moderated.
special optional boolean	If `true`, messages with this tag will be sent as special notices.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid name" is returned if the name is missing or invalid.
"bad_request"	"name exists" is returned if a hashtag with that name already exists.
"bad_request"	"invalid reply_to" is returned if the reply_to is missing or invalid.
"bad_request"	"invalid until" is returned if the until is missing or invalid.
"bad_request"	"invalid color" is returned if the color is missing or invalid.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatehashtag

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatehashtag' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'name=#Test'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("name", "#Test")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatehashtag", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatehashtag");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("name", "#Test");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 541,
   "object": "hashtag",
   "created": "2020-09-17T11:22:00-07:00",
   "group_id": 1188,
   "name": "Karl",
   "mods_only_post": false,
   "mods_only_replies": false,
   "no_email": false,
   "moderated": false,
   "special": true,
   "replies_unmoderated": false,
   "locked": true,
   "until": "hashtag_delete_month",
   "close_instead_of_delete": true,
   "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
   "color_name": "pink",
   "color_hex": "#f39de4",
   "reply_to": "thread_reply_to_sender",
   "topic_count": 1789,
   "last_message_date": "2020-09-08T01:22:00-07:00",
   "muted": null,
   "followed": null
}

View Hashtag definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "name exists"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid reply_to"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid until"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid color"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Hashtags#

GET /api/v1/gethashtags

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get hashtags

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/gethashtags

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/gethashtags' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/gethashtags"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/gethashtags");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 541,
       "object": "hashtag",
       "created": "2020-09-17T11:22:00-07:00",
       "group_id": 1188,
       "name": "Karl",
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": true,
       "replies_unmoderated": false,
       "locked": true,
       "until": "hashtag_delete_month",
       "close_instead_of_delete": true,
       "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
       "color_name": "pink",
       "color_hex": "#f39de4",
       "reply_to": "thread_reply_to_sender",
       "topic_count": 1789,
       "last_message_date": "2020-09-08T01:22:00-07:00",
       "muted": null,
       "followed": null
     }
   ],
   "end_item": 26,
   "has_more": false,
   "next_page_token": 84,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 22,
   "total_count": 80
}

View Hashtag List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Hashtag#

POST /api/v1/deletehashtag

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Delete a hashtag.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
name required string	Name of the hashtag, should begin with #.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

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.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletehashtag

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletehashtag' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'name=#Test'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("name", "#Test")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletehashtag", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletehashtag");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("name", "#Test");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Mute Hashtag#

POST /api/v1/mutehashtag

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be subscribed to the group.

Mute a hashtag.

POST Parameters

hashtag required string	Hashtag to mute.
group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
until required string	How long to mute the hashtag for, can be `mute_hour`, `mute_day`, `mute_week`, `mute_month`, `mute_forever`.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/mutehashtag

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/mutehashtag' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'hashtag=#test' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("hashtag", "#test")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/mutehashtag", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/mutehashtag");
    const body = new URLSearchParams();
    body.append("hashtag", "#test");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid until"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Unmute Hashtag#

POST /api/v1/unmutehashtag

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be subscribed to the group.

Unmute a hashtag.

POST Parameters

hashtag required string	Hashtag to unmute.
group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/unmutehashtag

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/unmutehashtag' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'hashtag=#test' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("hashtag", "#test")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/unmutehashtag", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/unmutehashtag");
    const body = new URLSearchParams();
    body.append("hashtag", "#test");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "not muting hashtag"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Follow Hashtag#

POST /api/v1/followhashtag

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be subscribed to the group.

Follow a hashtag.

POST Parameters

hashtag required string	Hashtag to follow.
group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
until required string	How long to follow the hashtag for, can be `mute_hour`, `mute_day`, `mute_week`, `mute_month`, `mute_forever`.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/followhashtag

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/followhashtag' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'hashtag=#test' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("hashtag", "#test")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/followhashtag", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/followhashtag");
    const body = new URLSearchParams();
    body.append("hashtag", "#test");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid until"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Unfollow Hashtag#

POST /api/v1/unfollowhashtag

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be subscribed to the group.

Unfollow a hashtag.

POST Parameters

hashtag required string	Hashtag to unfollow.
group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/unfollowhashtag

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/unfollowhashtag' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'hashtag=#test' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("hashtag", "#test")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/unfollowhashtag", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/unfollowhashtag");
    const body = new URLSearchParams();
    body.append("hashtag", "#test");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "not following hashtag"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Login Methods

Login#

POST /api/v1/login

Authentication: No authentication required Request: application/x-www-form-urlencoded Response: application/json

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

Returns

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

Additional Errors

	An `invalid email` error is returned if the email parameter is missing or does not match an account.
	An `invalid password` error is returned if the password parameter is missing or the password is incorrect.
	If the account is configured to require two factor authentication, and the twofactor parameter is not provided, a `2nd_factor_required` error is returned.
	If the provided twofactor code is incorrect, a `2nd_factor_wrong` error is returned.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

POST /api/v1/login

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/login' \
  --cookie-jar cookies.txt \
  --request POST \
  --data-urlencode 'email=test@example.com' \
  --data-urlencode 'password=qwerty'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("email", "test@example.com")
    params.Add("password", "qwerty")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/login", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/login");
    const body = new URLSearchParams();
    body.append("email", "test@example.com");
    body.append("password", "qwerty");

    const response = await fetch(url, {
        method: "POST",
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "token": "aabbffed2213234",
   "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_default"
   }
}

View Login definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Enterprise Info#

GET /api/v1/getenterpriseinfo

Authentication: No authentication required Request: Query string Response: HTTP 200 · empty body

Return information about an enterprise group.

Query Parameters

domain required string	Domain of the enterprise group.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

GET /api/v1/getenterpriseinfo

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getenterpriseinfo' \
  --get \
  --data-urlencode 'domain=groups.example.com'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("domain", "groups.example.com")
    endpoint := "https://groups.io/api/v1/getenterpriseinfo"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getenterpriseinfo");
    url.searchParams.append("domain", "groups.example.com");

    const response = await fetch(url, {
        method: "GET"
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid domain"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Logout#

GET /api/v1/logout

Authentication: Session cookie Request: Query string Response: HTTP 200 · empty body

Clear all cookies associated with authentication.

Returns

Returns HTTP 200 on success.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

GET /api/v1/logout

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/logout' \
  --cookie cookies.txt --cookie-jar cookies.txt

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/logout"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/logout");

    const response = await fetch(url, {
        method: "GET"
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Send Login Link#

POST /api/v1/sendloginlink

Authentication: No authentication required Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

None.

Send a login link

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

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.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

POST /api/v1/sendloginlink

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/sendloginlink' \
  --request POST \
  --data-urlencode 'email=test@example.com'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("email", "test@example.com")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/sendloginlink", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/sendloginlink");
    const body = new URLSearchParams();
    body.append("email", "test@example.com");

    const response = await fetch(url, {
        method: "POST",
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid email"
}

"invalid email" is returned if the email address is missing or invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "inactive user"
}

"inactive user" is returned if the user account has been deactivated.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Authenticate Login Link#

POST /api/v1/authenticateloginlink

Authentication: No authentication required Request: application/x-www-form-urlencoded Response: application/json

Permissions:

None.

Authenticate a login link

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

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

Additional Errors

If the account is configured to require two factor authentication, and the twofactor parameter is not provided, a 2nd_factor_required error is returned. If the provided twofactor code is incorrect, a 2nd_factor_wrong error is returned.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

POST /api/v1/authenticateloginlink

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/authenticateloginlink' \
  --request POST \
  --data-urlencode 'cookie=12345678'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("cookie", "12345678")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/authenticateloginlink", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/authenticateloginlink");
    const body = new URLSearchParams();
    body.append("cookie", "12345678");

    const response = await fetch(url, {
        method: "POST",
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "token": "aabbffed2213234",
   "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_default"
   }
}

View Login definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Facebook Login Start#

GET /api/v1/facebookloginstart

Authentication: No authentication required Request: Query string Response: application/json

Start the Facebook login process.

Returns

Returns an oauth login object. Returns an error otherwise.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

GET /api/v1/facebookloginstart

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/facebookloginstart'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/facebookloginstart"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/facebookloginstart");

    const response = await fetch(url, {
        method: "GET"
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Oauth Login definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Facebook Login Final#

POST /api/v1/facebookloginfinal

Authentication: No authentication required Request: application/x-www-form-urlencoded Response: application/json

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

POST Parameters

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

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

POST /api/v1/facebookloginfinal

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/facebookloginfinal' \
  --request POST \
  --data-urlencode 'code=xxx' \
  --data-urlencode 'state=yyy'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("code", "xxx")
    params.Add("state", "yyy")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/facebookloginfinal", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/facebookloginfinal");
    const body = new URLSearchParams();
    body.append("code", "xxx");
    body.append("state", "yyy");

    const response = await fetch(url, {
        method: "POST",
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "token": "aabbffed2213234",
   "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_default"
   }
}

View Login definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid state"
}

"invalid state" is returned if the state parameter is invalid or missing.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid code or access_token"
}

"invalid code or access_token" is returned if the code and access_token parameters are invalid or missing.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "expired code"
}

"expired code" is returned if the code parameter is expired. Start the process over in this case.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "inactive user"
}

"inactive user" is returned if the user has been disabled.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid email address"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "two factor enabled"
}

"two factor enabled" is returned if the user has two-factor authentication enabled, which prevents Facebook logins.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "facebook login prevented"
}

"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.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Google Login Start#

GET /api/v1/googleloginstart

Authentication: No authentication required Request: Query string Response: application/json

Start the Google login process.

Returns

Returns an oauth login object. Returns an error otherwise.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

GET /api/v1/googleloginstart

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/googleloginstart'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/googleloginstart"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/googleloginstart");

    const response = await fetch(url, {
        method: "GET"
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Oauth Login definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Google Login Final#

POST /api/v1/googleloginfinal

Authentication: No authentication required Request: application/x-www-form-urlencoded Response: application/json

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

POST Parameters

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

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

POST /api/v1/googleloginfinal

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/googleloginfinal' \
  --request POST \
  --data-urlencode 'code=xxx' \
  --data-urlencode 'state=yyy'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("code", "xxx")
    params.Add("state", "yyy")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/googleloginfinal", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/googleloginfinal");
    const body = new URLSearchParams();
    body.append("code", "xxx");
    body.append("state", "yyy");

    const response = await fetch(url, {
        method: "POST",
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "token": "aabbffed2213234",
   "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_default"
   }
}

View Login definition

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid state"
}

"invalid state" is returned if the state parameter is invalid or missing.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid code"
}

"invalid code" is returned if the code parameter is invalid or missing.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "inactive user"
}

"inactive user" is returned if the user has been disabled.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "two factor enabled"
}

"two factor enabled" is returned if the user has two-factor authentication enabled, which prevents Google logins.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid email address"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "google login prevented"
}

"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.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Member Notices

Endpoints to manipulate member notices.

New Member Notice#

POST /api/v1/newmembernotice

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Create a new member notice.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
name required string	Name of this member notice
type required string	Type of member notice, can be: `member_notice_joining`, `member_notice_pending`, `member_notice_leaving`, `member_notice_banned`, `member_notice_rejected_sub`, `member_notice_invite`, `member_notice_direct_add`, `member_notice_rejected_message`, `member_notice_removed_sub`, `member_notice_post_to_sub`, `member_notice_guidelines`, `member_notice_locked_group`, `member_notice_monthly_reminder`
subject required string	Subject used when sending emails
message required string	The message, in HTML format
guidelines_subject optional string	For Guidelines, the subject to use when sending the monthly email
is_default optional boolean	Use this message for email commands
send_on_join optional boolean	For Guidelines, send to new members at same time as welcome message
send_monthly optional boolean	For Guidelines, send monthly to the group members
send_monthly_special optional boolean	For Guidelines, send monthly to members on special only
private optional boolean	For Guidelines, if the guidelines are public or for members only
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newmembernotice

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newmembernotice' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'subject=Test' \
  --data-urlencode 'name=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("subject", "Test")
    params.Add("name", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newmembernotice", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newmembernotice");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("subject", "Test");
    body.append("name", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Member Notice definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid subject"
}

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

Example 400 · application/json · bad_request

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

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid message"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "already have guidelines"
}

"already have guidelines" is returned if the message is of type group_message_guidelines and there already is a notice of the same type.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Member Notice#

POST /api/v1/updatemembernotice

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Update a member notice object.

POST Parameters

member_notice_id required integer	ID of the member notice to update.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
name optional string	Name of this member notice
type optional string	Type of member notice, can be: `member_notice_joining`, `member_notice_pending`, `member_notice_leaving`, `member_notice_banned`, `member_notice_rejected_sub`, `member_notice_invite`, `member_notice_direct_add`, `member_notice_rejected_message`, `member_notice_removed_sub`, `member_notice_post_to_sub`, `member_notice_guidelines`, `member_notice_locked_group`, `member_notice_monthly_reminder`
subject optional string	Subject used when sending emails
message optional string	The message, in HTML format
guidelines_subject optional string	For Guidelines, the subject to use when sending the monthly email
is_default optional boolean	Use this message for email commands
send_on_join optional boolean	For Guidelines, send to new members at same time as welcome message
send_monthly optional boolean	For Guidelines, send monthly to the group members
send_monthly_special optional boolean	For Guidelines, send monthly to members on special only
private optional boolean	For Guidelines, if the guidelines are public or for members only
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatemembernotice

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatemembernotice' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'member_notice_id=12' \
  --data-urlencode 'subject=Test' \
  --data-urlencode 'name=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("member_notice_id", "12")
    params.Add("subject", "Test")
    params.Add("name", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatemembernotice", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatemembernotice");
    const body = new URLSearchParams();
    body.append("member_notice_id", "12");
    body.append("subject", "Test");
    body.append("name", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Member Notice definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid member_notice_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "already have guidelines"
}

"already have guidelines" is returned if the message is of type group_message_guidelines and there already is a notice of the same type.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Member Notice#

POST /api/v1/deletemembernotice

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Delete a member notice object.

POST Parameters

member_notice_id required integer	ID of the member notice to delete.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletemembernotice

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletemembernotice' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'member_notice_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("member_notice_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletemembernotice", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletemembernotice");
    const body = new URLSearchParams();
    body.append("member_notice_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid member_notice_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Member Notices#

GET /api/v1/getmembernotices

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
type optional string	Type of member notice to return, can be: `member_notice_joining`, `member_notice_pending`, `member_notice_leaving`, `member_notice_banned`, `member_notice_rejected_sub`, `member_notice_invite`, `member_notice_direct_add`, `member_notice_rejected_message`, `member_notice_removed_sub`, `member_notice_post_to_sub`, `member_notice_guidelines`, `member_notice_locked_group`, `member_notice_monthly_reminder`
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are: `name`, `msgtype`, `updated`, `created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getmembernotices

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getmembernotices' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getmembernotices"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getmembernotices");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 25,
       "guidelines_monthly_subject": "",
       "id": 38,
       "is_default": false,
       "message": "",
       "name": "",
       "object": "member_notice",
       "private": false,
       "send_monthly": false,
       "send_monthly_special": false,
       "send_on_join": false,
       "subject": "",
       "type": "member_notice_banned",
       "updated": "2009-11-10T15:00:00-08:00"
     }
   ],
   "end_item": 75,
   "has_more": false,
   "next_page_token": 37,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 86,
   "total_count": 7
}

View Member Notice List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Members

Approve Pending Member#

POST /api/v1/approvemember

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the manage_pending_members permission to use this call.

Approve a pending member.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/approvemember

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/approvemember' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=1' \
  --data-urlencode 'member_info_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "1")
    params.Add("member_info_id", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/approvemember", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/approvemember");
    const body = new URLSearchParams();
    body.append("group_id", "1");
    body.append("member_info_id", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Ban Member#

POST /api/v1/banmember

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the ban_members permission to use this call.

Ban this member.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/banmember

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/banmember' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=1' \
  --data-urlencode 'member_info_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "1")
    params.Add("member_info_id", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/banmember", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/banmember");
    const body = new URLSearchParams();
    body.append("group_id", "1");
    body.append("member_info_id", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Bulk Remove Members#

POST /api/v1/bulkremovemembers

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the remove_members permission to use this call.

Remove one or more members from a group.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
emails required string	A newline separated list of email addresses to remove.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
send_notice optional boolean	If true, send the Removed Member notice to each removed member.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

	An `invalid_file` error is returned if an uploaded file is in a format that cannot be read as a list of addresses, such as a spreadsheet or a PDF.

Notes

Addresses that are not valid email addresses are reported in the results with a status of bulk_remove_invalid_email; they are not looked up.
If a removed member's status is sub_status_pending, the active Rejected Subscription member notice will be sent to the member, if there is one.
If a removed member's status is sub_status_normal, the active Removed Member notice will be sent to the member, if there is one.
If a removed member's status is sub_status_banned, no member notices will be sent out.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/bulkremovemembers

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/bulkremovemembers' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'emails=person@example.com' \
  --data-urlencode 'send_notice=false'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("emails", "person@example.com")
    params.Add("send_notice", "false")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/bulkremovemembers", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/bulkremovemembers");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("emails", "person@example.com");
    body.append("send_notice", "false");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "errors": [
     {
       "email": "",
       "object": "remove_error",
       "status": "bulk_remove_db_error"
     }
   ],
   "object": "bulk_remove_results",
   "removed": 76,
   "total_emails": 45
}

View Bulk Remove Results definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Direct Add#

POST /api/v1/directadd

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Directly add people to a group.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
emails required string	A newline separated list of email addresses to add.
csrf string	The `csrf_token` from the user object returned when first logged in.
subject optional string	Subject line to use for the direct add notification sent to users.
message optional string	Message to include with the direct add notification sent to users.
subgroupids optional string	A comma separated list of IDs of sub groups to also add these people to.
subgroupnames optional string	A comma separated list of names of sub groups to also add these people to.
restore_subgroups optional boolean	If `true`, people who were previously members of the group are also added back to the subgroups they belonged to when they were removed, with their previous delivery settings. Moderator/owner roles are not restored.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/directadd

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/directadd' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=4' \
  --data-urlencode 'emails=test@example.com'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "4")
    params.Add("emails", "test@example.com")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/directadd", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/directadd");
    const body = new URLSearchParams();
    body.append("group_id", "4");
    body.append("emails", "test@example.com");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "added_members": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "errors": [
     {
       "alias_of": "",
       "email": "",
       "group_id": 41,
       "object": "direct_add_error",
       "status": ""
     }
   ],
   "object": "direct_add_results",
   "total_emails": 72
}

View Direct Add Results definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Member#

GET /api/v1/getmember

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must have the members_visible permission to use this call.

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

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getmember

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getmember' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=2' \
  --data-urlencode 'member_info_id=46'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "2")
    params.Add("member_info_id", "46")
    endpoint := "https://groups.io/api/v1/getmember"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getmember");
    url.searchParams.append("group_id", "2");
    url.searchParams.append("member_info_id", "46");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Member Directory#

GET /api/v1/getmemberdirectory

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must have the view_member_directory permission to use this call.

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

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `full_name`.
sort_dir optional string	Sort direction. Can be 'asc' or 'desc'.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"private profile" is returned the user's profile is private. Only people without a private profile can view the member directory.

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getmemberdirectory

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getmemberdirectory' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=7'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "7")
    endpoint := "https://groups.io/api/v1/getmemberdirectory"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getmemberdirectory");
    url.searchParams.append("group_id", "7");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "end_item": 99,
   "has_more": false,
   "next_page_token": 48,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 71,
   "total_count": 67
}

View Member Info List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "private profile"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Members#

GET /api/v1/getmembers

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must have the members_visible or view_member_directory permission to use this call.

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getmembers

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getmembers' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=7'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "7")
    endpoint := "https://groups.io/api/v1/getmembers"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getmembers");
    url.searchParams.append("group_id", "7");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "end_item": 8,
   "has_more": false,
   "next_page_token": 27,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 68,
   "total_count": 2
}

View Member Info List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Past Members#

GET /api/v1/getpastmembers

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getpastmembers

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getpastmembers' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=7'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "7")
    endpoint := "https://groups.io/api/v1/getpastmembers"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getpastmembers");
    url.searchParams.append("group_id", "7");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "action": "spamleft",
       "created": "2009-11-10T15:00:00-08:00",
       "id": 59,
       "member_info": {
         "id": 93846546,
         "object": "member_info",
         "created": "2020-09-09T04:11:00-07:00",
         "updated": "2022-06-08T07:16:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "group_name": "StrategyHub",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_digest",
         "message_selection": "message_selection_follow_and_first_message",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_medium",
         "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "In hotel furniture anyone weakly besides",
         "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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "member_labels": [
           {
             "id": 726,
             "object": "memberlabel",
             "created": "2020-09-29T22:19:00Z",
             "group_id": 1857,
             "name": "Florida",
             "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
             "color_name": "green-sage",
             "color_hex": "#9fc4ac"
           },
           {
             "id": 1594,
             "object": "memberlabel",
             "created": "2020-09-24T02:24:00Z",
             "group_id": 42,
             "name": "Russel",
             "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
             "color_name": "purple",
             "color_hex": "#837fd5"
           },
           {
             "id": 1189,
             "object": "memberlabel",
             "created": "2020-09-12T02:11:00Z",
             "group_id": 1474,
             "name": "Meta",
             "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
             "color_name": "sky",
             "color_hex": "#9cc7df"
           }
         ],
         "extra_member_data": [
           {
             "col_id": 48876437,
             "col_type": "text_column",
             "text": "To firstly unlock while host himself me purely as whose."
           },
           {
             "col_id": 161476183,
             "col_type": "paragraph_column",
             "text": "Yet few mustering example will addition yearly since in these."
           },
           {
             "col_id": 39354277,
             "col_type": "checkbox_column",
             "checked": false
           },
           {
             "col_id": 8897324,
             "col_type": "multiple_choice_column",
             "multi_choice": [
               0
             ]
           },
           {
             "col_id": 159828550,
             "col_type": "date_column",
             "date": "1923-10-16T17:57:55.797000001Z"
           },
           {
             "col_id": 185149472,
             "col_type": "time_column",
             "time": "1929-03-30T18:00:36.790929649Z"
           },
           {
             "col_id": 166814414,
             "col_type": "address_column",
             "street_address1": "Premier Medical Group",
             "street_address2": "3701 DAUPHIN ST",
             "city": "MOBILE",
             "state": "AL",
             "zip": "36608-1756",
             "lat": 30.6866076,
             "lng": -88.13019249999999
           },
           {
             "col_id": 102385421,
             "col_type": "multi_choice_column",
             "multi_choice": [
               0,
               1,
               2
             ]
           },
           {
             "col_id": 154317202,
             "col_type": "link_column",
             "title": "To say poorly out according abundant unless nervously string lastly.",
             "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
             "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
           },
           {
             "col_id": 123191768,
             "col_type": "image_column",
             "url": "https://picsum.photos/id/27/187/110",
             "image_name": "Lately blazer with wild hourly there she it infrequently power."
           },
           {
             "col_id": 53386358,
             "col_type": "html_paragraph_column",
             "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
           },
           {
             "col_id": 45812071,
             "col_type": "email_column",
             "text": "brantkozey@bernhard.com"
           }
         ]
       },
       "object": "past_member"
     }
   ],
   "end_item": 43,
   "has_more": false,
   "next_page_token": 44,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 27,
   "total_count": 64
}

View Past Member List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Remove Member#

POST /api/v1/removemember

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the remove_members permission to use this call.

Remove a member from a group.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/removemember

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/removemember' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=1' \
  --data-urlencode 'member_info_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "1")
    params.Add("member_info_id", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/removemember", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/removemember");
    const body = new URLSearchParams();
    body.append("group_id", "1");
    body.append("member_info_id", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Search Member Directory#

GET /api/v1/searchmemberdirectory

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must have the view_member_directory permission to use this call.

Search the member directory. The search is over full names and profile information. Each member is represented by a member info object. Member info objects are returned using the pagination request and object format.

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/searchmemberdirectory

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/searchmemberdirectory' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=7' \
  --data-urlencode 'q=Fred'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "7")
    params.Add("q", "Fred")
    endpoint := "https://groups.io/api/v1/searchmemberdirectory"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/searchmemberdirectory");
    url.searchParams.append("group_id", "7");
    url.searchParams.append("q", "Fred");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "end_item": 94,
   "has_more": false,
   "next_page_token": 30,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 17,
   "total_count": 48
}

View Member Info List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Search Members#

GET /api/v1/searchmembers

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must have the members_visible permission to use this call.

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/searchmembers

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/searchmembers' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=7' \
  --data-urlencode 'q=smith.com'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "7")
    params.Add("q", "smith.com")
    endpoint := "https://groups.io/api/v1/searchmembers"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/searchmembers");
    url.searchParams.append("group_id", "7");
    url.searchParams.append("q", "smith.com");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "end_item": 23,
   "has_more": false,
   "next_page_token": 8,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 11,
   "total_count": 30
}

View Member Info List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Send A Bounce Probe#

POST /api/v1/sendbounceprobe

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the manage_member_subscription_options permission to use this call.

Send a bounce probe.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/sendbounceprobe

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/sendbounceprobe' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=1' \
  --data-urlencode 'member_info_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "1")
    params.Add("member_info_id", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/sendbounceprobe", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/sendbounceprobe");
    const body = new URLSearchParams();
    body.append("group_id", "1");
    body.append("member_info_id", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Send A Confirmation Email#

POST /api/v1/sendconfirmation

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must have the manage_member_subscription_options permission to use this call.

Send a confirmation email.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/sendconfirmation

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/sendconfirmation' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=1' \
  --data-urlencode 'member_info_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "1")
    params.Add("member_info_id", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/sendconfirmation", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/sendconfirmation");
    const body = new URLSearchParams();
    body.append("group_id", "1");
    body.append("member_info_id", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Send Invites#

POST /api/v1/invite

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Send invites.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
emails required string	A newline separated list of email addresses to invite.
csrf string	The `csrf_token` from the user object returned when first logged in.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

NOTE: This call is not yet finished and documented.

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/invite

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/invite' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=4' \
  --data-urlencode 'emails=test@example.com'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "4")
    params.Add("emails", "test@example.com")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/invite", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/invite");
    const body = new URLSearchParams();
    body.append("group_id", "4");
    body.append("emails", "test@example.com");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "added_members": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "errors": [
     {
       "alias_of": "",
       "email": "",
       "group_id": 17,
       "object": "direct_add_error",
       "status": ""
     }
   ],
   "object": "direct_add_results",
   "total_emails": 14
}

View Direct Add Results definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Unban Member#

POST /api/v1/unbanmember

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must have the ban_members permission to use this call.

Unban this member.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/unbanmember

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/unbanmember' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=1' \
  --data-urlencode 'member_info_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "1")
    params.Add("member_info_id", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/unbanmember", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/unbanmember");
    const body = new URLSearchParams();
    body.append("group_id", "1");
    body.append("member_info_id", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Extra Member Column#

POST /api/v1/updateextramembercolumn

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Update a single member's extra member data value for one column.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
column_id required integer	ID of the extra member data column whose value to set. Column IDs can be found in the `extra_member_data_columns` array of the group object, in each column's `id` field.
value optional string	The value to set. Used for `text`, `paragraph`, `email`, `number`, `checkbox`, `multiple_choice`, `multi_choice`, and `html_paragraph` column types. For `number` columns, pass a numeric string or empty string to clear. For `checkbox` columns, pass `true` or `false`. For `multiple_choice` columns, pass the choice index (1-based) or `0` to clear. For `multi_choice` columns, pass a JSON array of choice indices (1-based), e.g. `[1,3]`.
street_address1 optional string	For `address` columns, the first street address line.
street_address2 optional string	For `address` columns, the second street address line.
city optional string	For `address` columns, the city.
state optional string	For `address` columns, the state or province.
zip optional string	For `address` columns, the zip or postal code.
country optional string	For `address` columns, the country name.
url optional string	For `link` columns, the URL.
title optional string	For `link` columns, the link title.
description optional string	For `link` columns, the link description.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

Returns the member info object if the update succeeded. Returns an error if parameters are invalid.

Additional Errors

bad_request	"column_id required" is returned if column_id is not provided.
bad_request	"invalid column_id" is returned if column_id is not a valid number.
bad_request	"column not found" is returned if the specified column does not exist in the group.
bad_request	"invalid number" is returned if the value for a number column is not a valid number.
bad_request	"invalid choice index" is returned if the value for a multiple_choice column is not a valid number.
bad_request	"choice index out of range" is returned if the choice index is out of range.
bad_request	"invalid multi_choice value, expected JSON array of indices" is returned if the value for a multi_choice column is not valid JSON.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updateextramembercolumn

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updateextramembercolumn' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=2' \
  --data-urlencode 'member_info_id=123' \
  --data-urlencode 'column_id=1' \
  --data-urlencode 'value=Hello World'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "2")
    params.Add("member_info_id", "123")
    params.Add("column_id", "1")
    params.Add("value", "Hello World")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updateextramembercolumn", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updateextramembercolumn");
    const body = new URLSearchParams();
    body.append("group_id", "2");
    body.append("member_info_id", "123");
    body.append("column_id", "1");
    body.append("value", "Hello World");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Member#

POST /api/v1/updatemember

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Change a member's subscription.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
post_status optional string	Posting status, can be `sub_poststatus_normal`, `sub_poststatus_allowed`, `sub_poststatus_moderated`, `sub_poststatus_notallowed`, `sub_poststatus_newusermoderated`, `sub_poststatus_mod_first_message`, `sub_poststatus_mod_started_topics`
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean	Automatically follow any topics you start or reply to.
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
full_name optional string	The member's full name.
moderator_notes optional string	Notes about the member.
chat_msg_notify optional string	Notify when someone posts a message to a chat this person is subscribed to, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
like_notify optional string	Notify when someone likes a message this person posted, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
You must have the `make_moderator` permission in order to set these fields
mod_status optional string	Moderator status, can be `sub_modstatus_none`, `sub_modstatus_moderator`, `sub_modstatus_owner`
mod_permissions optional string	Moderator permissions, comma separated list of zero or more of the following: `sub_perm_pendingmsgs`, `sub_perm_pendingmembers`, `sub_perm_invitemembers`, `sub_perm_removemembers`, `sub_perm_banmembers`, `sub_perm_makemoderator`, `sub_perm_managehashtags`, `sub_perm_groupsettings`, `sub_perm_modsub`, `sub_perm_integrations`, `sub_perm_editarchives`, `sub_perm_billing`, `sub_perm_managesubgroups`
pending_msg_notify optional string	Notify about pending messages, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
pending_sub_notify optional string	Notify about pending subscriptions, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
sub_notify optional string	Notify when someone joins the group, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
storage_notify optional string	Notify when storage limits are reached, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
sub_group_notify optional string	Notify when a subgroup is created, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
message_report_notify optional string	Notify when someone reports a message, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
chat_notify optional string	Notify when someone starts a chat, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
photo_notify optional string	Notify when someone creates a photo album or uploads a photo, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
file_notify optional string	Notify when someone creates a folder or uploads a file, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
wiki_notify optional string	Notify when someone creates or modifies a wiki page, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
database_notify optional string	Notify when someone creates or modifies a database, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
color optional string	Color assigned to the member.
member_labels optional string repeated field	Array of member label IDs to assign to the member. Can also include new label temporary IDs (prefixed with 'new_') to create and assign new labels.
new_label_names optional string repeated field	Array of names for new labels being created (corresponds to memberlabels with 'new' prefix).
new_label_colors optional string repeated field	Array of color values for new labels being created (corresponds to memberlabels with 'new' prefix).
new_label_descriptions optional string repeated field	Array of descriptions for new labels being created (corresponds to memberlabels with 'new' prefix).
owner_msg_notify optional string	Receive messages sent to the +owner address, can be `sub_ownermsg_notify_all`, `sub_ownermsg_notify_subs`, `sub_ownermsg_notify_none`
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.
	The following fields relate to setting extra_member_data fields. Each column, as defined in the `extra_member_data_columns` array in the Group Object, consists of a Database Column Object, which defines the various aspects of the column.
text_N optional string	Response for `text` and `paragraph` columns. N is the ID of column.
number_N optional number	Response for `number` columns. N is the ID of column.
editor_N optional string	Response for `html_paragraph` columns. N is the ID of column.
checked_N optional boolean	Response for `checkbox` columns. N is the ID of column.
choice_N optional number	Choice index for `multiple_choice` columns, starting at 1; use 0 to clear. N is the ID of the column.
multichoice_N_M optional boolean	Response for `multi_choice` columns. N is the ID of column. M corresponds to the `choices` array in the database column object, indexed starting at 1.
date_N optional string	Response for `date` columns. N is the ID of the column.
time_N optional string	Response for `time` columns. N is the ID of the column.
address1_N optional string	First address line for `address` columns. N is the ID of the column.
address2_N optional string	Second address line for `address` columns. N is the ID of the column.
city_N optional string	City line for `address` columns. N is the ID of the column.
state_N optional string	State line for `address` columns. N is the ID of the column.
zip_N optional string	Zip line for `address` columns. N is the ID of the column.
country_N optional string	Country line for `address` columns. N is the ID of the column.
url_N optional string	URL for `link` columns. N is the ID of the column.
title_N optional string	Title for `link` columns. N is the ID of the column.
desc_N optional string	Description for `link` columns. N is the ID of the column.

Returns

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

Additional Errors

"bad_request"	"sole group owner" is returned if changing the `mod_status` field will leave the group without any owners.
"bad_request"	"moderators cannot change role of owners" is returned if a non-owner attempts to change the `mod_status` field of an owner.
"bad_request"	"moderators cannot make members owners" is returned if a non-owner attempts to make a member an owner.
"bad_request"	"moderators cannot change owner subscription settings" is returned if a non-owner attempts to change an owner's subscription settings.

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatemember

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatemember' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=1' \
  --data-urlencode 'member_info_id=2' \
  --data-urlencode 'post_status=sub_poststatus_normal'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "1")
    params.Add("member_info_id", "2")
    params.Add("post_status", "sub_poststatus_normal")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatemember", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatemember");
    const body = new URLSearchParams();
    body.append("group_id", "1");
    body.append("member_info_id", "2");
    body.append("post_status", "sub_poststatus_normal");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "sole group owner"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "moderators cannot change role of owners"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "moderators cannot make members owners"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "moderators cannot change owner subscription settings"
}

"moderators cannot change owner subscription settings" is returned if a non-owner attempts to change an owner's subscription settings.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Notifications

These API endpoints deal with pushsub notifications.

Add Push Sub#

POST /api/v1/addpushsub

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

None.

POST Parameters

token required string	Device ID token.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/addpushsub

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/addpushsub' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'token=abcdef'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("token", "abcdef")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/addpushsub", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/addpushsub");
    const body = new URLSearchParams();
    body.append("token", "abcdef");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid token"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Test Notification#

POST /api/v1/testnotification

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

None.

Send a test notification.

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
token required string	Device ID token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/testnotification

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/testnotification' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/testnotification", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/testnotification");
    const body = new URLSearchParams();

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid token"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Push Subs#

GET /api/v1/getpushsubs

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

None.

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

Query Parameters

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

Returns

Returns a push sub list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getpushsubs

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getpushsubs' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getpushsubs"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getpushsubs");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "auth": "",
       "browser": "app",
       "created": "2009-11-10T15:00:00-08:00",
       "endpoint": "",
       "id": 89,
       "object": "push_sub",
       "os": "",
       "p256dh": "",
       "type": "mobile_push_sub",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 60
     }
   ],
   "end_item": 5,
   "has_more": false,
   "next_page_token": 11,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 36,
   "total_count": 95
}

View Push Sub List definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Push Subscription#

POST /api/v1/deletepushsub

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

None.

Delete a single push subscription.

POST Parameters

pushsub_id required integer	ID of the pushsub to delete. You must be the owner of the pushsub.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletepushsub

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletepushsub' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'pushsub_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("pushsub_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletepushsub", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletepushsub");
    const body = new URLSearchParams();
    body.append("pushsub_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid pushsub_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete All Push Subscriptions#

POST /api/v1/deleteallpushsubs

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

None.

Delete all push subscriptions for a user.

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

None.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deleteallpushsubs

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deleteallpushsubs' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deleteallpushsubs", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deleteallpushsubs");
    const body = new URLSearchParams();

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Orgs

Orgs represent enterprise groups.

Get Org#

GET /api/v1/getorg

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must be an owner of the requested enterprise group.

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

Query Parameters

None

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getorg

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getorg' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getorg"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getorg");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Org definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Pending Messages

Get Pending Messages#

GET /api/v1/getpendingmessages

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

Returns a pending message list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getpendingmessages

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getpendingmessages' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getpendingmessages"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getpendingmessages");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "body_format": "",
       "claimed_date": "2009-11-10T15:00:00-08:00",
       "claiming_user": {
         "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "name": "Lawson Kreiger",
         "can_view_profile": false
       },
       "created": "2009-11-10T15:00:00-08:00",
       "edit_reason": "",
       "editor": {
         "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "name": "Lawson Kreiger",
         "can_view_profile": false
       },
       "editor_member_id": 30,
       "group_id": 81,
       "has_attachments": false,
       "id": 95,
       "is_special": false,
       "is_web_post": false,
       "message_body": "",
       "object": "pending_message",
       "raw_message": "",
       "sender": {
         "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "name": "Lawson Kreiger",
         "can_view_profile": false
       },
       "sender_email": "",
       "sender_name": "",
       "subject": "",
       "type": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 1,
       "virus_name": ""
     }
   ],
   "end_item": 55,
   "has_more": false,
   "next_page_token": 86,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 25,
   "total_count": 60
}

View Pending Message List definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Approve Pending Messages#

POST /api/v1/approvependingmessages

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

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

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
pending_message_ids required numbers	Comma separated list of IDs of the pending messages to approve.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

"bad_request"	"invalid pending_message_ids" is returned if the pending message id is missing or invalid.
"bad_request"	"message claimed" is returned if the pending message has previously been claimed by someone else.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/approvependingmessages

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/approvependingmessages' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'pending_message_ids=12' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("pending_message_ids", "12")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/approvependingmessages", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/approvependingmessages");
    const body = new URLSearchParams();
    body.append("pending_message_ids", "12");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid pending_message_ids"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "message claimed"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Claim Pending Message#

POST /api/v1/claimpendingmessage

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

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

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
pending_message_id required integer	ID of the pending message to delete.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/claimpendingmessage

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/claimpendingmessage' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'pending_message_id=12' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("pending_message_id", "12")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/claimpendingmessage", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/claimpendingmessage");
    const body = new URLSearchParams();
    body.append("pending_message_id", "12");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid pending_message_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Pending Messages#

POST /api/v1/deletependingmessages

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Delete pending message objects.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
pending_message_ids required numbers	Comma separated list of IDs of the pending messages to delete. All messages must be in the same group.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

"bad_request"	"invalid pending_message_ids" is returned if the pending message id is missing or invalid.
"bad_request"	"message claimed" is returned if the pending message has previously been claimed by someone else.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletependingmessages

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletependingmessages' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'pending_message_ids=12' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("pending_message_ids", "12")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletependingmessages", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletependingmessages");
    const body = new URLSearchParams();
    body.append("pending_message_ids", "12");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid pending_message_ids"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "message claimed"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Reject Pending Messages#

POST /api/v1/rejectpendingmessages

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

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

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
pending_message_ids required numbers	Comma separated list of IDs of the pending messages to reject.
reason required string	The message to send the person who sent each pending message, in plain text.
subject required string	The subject line of the message to send the person who sent the pending message, in plain text.
bccall optional boolean	If `true`, email all group moderators a copy of the rejection message.
bccme optional boolean	If `true`, email me a copy of the rejection message.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.

Returns

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

Additional Errors

"bad_request"	"invalid pending_message_ids" is returned if the pending message id is missing or invalid.
"bad_request"	"invalid reason" is returned if the reason is missing or invalid.
"bad_request"	"invalid subject" is returned if the subject is missing or invalid.
"bad_request"	"message claimed" is returned if the pending message has previously been claimed by someone else.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/rejectpendingmessages

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/rejectpendingmessages' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'pending_message_ids=12' \
  --data-urlencode 'reason="I'"'"'m rejecting this"' \
  --data-urlencode 'subject="Rejection message"' \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("pending_message_ids", "12")
    params.Add("reason", "\"I'm rejecting this\"")
    params.Add("subject", "\"Rejection message\"")
    params.Add("group_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/rejectpendingmessages", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/rejectpendingmessages");
    const body = new URLSearchParams();
    body.append("pending_message_ids", "12");
    body.append("reason", "\"I'm rejecting this\"");
    body.append("subject", "\"Rejection message\"");
    body.append("group_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid pending_message_ids"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid reason"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid subject"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "message claimed"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Photos

These are the API endpoints for albums and photos.

New Photo Album#

POST /api/v1/newalbum

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Create a new photo album. The album is created.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
title required string	The title of the album.
desc required string	The description of the album, in plain text format.
upload_perms required string	Who can upload photos to this album. Can be: `album_upload_group` or `album_upload_personal`.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newalbum

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newalbum' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'title=Test' \
  --data-urlencode 'desc=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("title", "Test")
    params.Add("desc", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newalbum", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newalbum");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("title", "Test");
    body.append("desc", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 52691321,
   "object": "album",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "parent_album_id": 0,
   "upload_perms": "album_upload_group",
   "title": "Including tribe anything from whose market",
   "desc": "Pyramid accordingly onto moreover whenever e.g. fear usually body kilometer. Nightly child so firstly he next each secondly must catch. Politely sleepy where i.e. inquisitively yours wisp regularly nice cackle. Ourselves heavily now this our yearly what few why where. Win most would everybody them backwards this that provided store.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 24
}

View Album definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid title"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid desc"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid upload_perms"
}

"invalid upload_perms" is returned if the upload_perms parameter is missing or invalid.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Photo Album#

POST /api/v1/updatealbum

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be the owner of the album.

Update a photo album.

POST Parameters

album_id required integer	ID of the album.
title optional string	The title of the album.
desc optional string	The description of the album, in plain text format.
upload_perms optional string	Who can upload photos to this album. Can be: `album_upload_group` or `album_upload_personal`.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatealbum

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatealbum' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'album_id=32' \
  --data-urlencode 'title=Test' \
  --data-urlencode 'desc=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("album_id", "32")
    params.Add("title", "Test")
    params.Add("desc", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatealbum", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatealbum");
    const body = new URLSearchParams();
    body.append("album_id", "32");
    body.append("title", "Test");
    body.append("desc", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 52691321,
   "object": "album",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "parent_album_id": 0,
   "upload_perms": "album_upload_group",
   "title": "Including tribe anything from whose market",
   "desc": "Pyramid accordingly onto moreover whenever e.g. fear usually body kilometer. Nightly child so firstly he next each secondly must catch. Politely sleepy where i.e. inquisitively yours wisp regularly nice cackle. Ourselves heavily now this our yearly what few why where. Win most would everybody them backwards this that provided store.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 24
}

View Album definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid album_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid title"
}

"invalid title" is returned if the title is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid desc"
}

"invalid desc" is returned if the desc is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid upload_perms"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Photo Albums#

GET /api/v1/getalbums

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getalbums

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getalbums' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getalbums"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getalbums");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "album",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "parent_album_id": 0,
       "upload_perms": "album_upload_group",
       "title": "Including tribe anything from whose",
       "desc": "Market pyramid accordingly onto moreover whenever e.g. fear usually body. Kilometer nightly child so firstly he next each secondly must. Catch politely sleepy where i.e. inquisitively yours wisp regularly nice. Cackle ourselves heavily now this our yearly what few why. Where win most would everybody them backwards this that provided.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 18
     },
     {
       "id": 134723079,
       "object": "album",
       "created": "2020-10-01T09:06:00-07:00",
       "updated": "2022-06-06T16:00:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "parent_album_id": 0,
       "upload_perms": "album_upload_group",
       "title": "Whom I company Roman indeed",
       "desc": "Words trade move outside downstairs of exemplified up out destroy. Due taste anything where this that would whom to cautiously. Till only himself fight our whomever that for her our. Much nevertheless which numerous alone bevy as by from e.g.. Otherwise laptop cloud then them yourselves few look fleet say.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 27
     },
     {
       "id": 112832928,
       "object": "album",
       "created": "2020-09-14T20:59:00-07:00",
       "updated": "2022-11-29T01:40:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "parent_album_id": 0,
       "upload_perms": "album_upload_group",
       "title": "Cruelly rarely over",
       "desc": "By otherwise its to a e.g. congregation cackle themselves previously. In for theirs they my there road disappear accordingly hotel. So today by over have this Romanian abroad around while. Belong ever into each whatever fortnightly he agreeable sari anyone. Therefore does could exaltation of sit everyone they had mustering.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 13
     }
   ]
}

View Album List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Photo Album#

POST /api/v1/deletealbum

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be the owner of the album.

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

POST Parameters

album_id required integer	ID of the album.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletealbum

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletealbum' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'album_id=32'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("album_id", "32")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletealbum", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletealbum");
    const body = new URLSearchParams();
    body.append("album_id", "32");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid album_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Add Photos#

POST /api/v1/addphotos

Authentication: Bearer API key, Basic token, or session cookie Request: multipart/form-data Response: application/json

Permissions:

You must have permission to add photos to the album.

Add photos.

Query Parameters

album_id required integer	ID of the photo album to add the photo to.
fileupload required multipart file	Multipart file upload of one or more photos.
description optional string	A description to be added to the photos.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid album_id" is returned if the album id is missing or invalid.
"bad_request"	"no space" is returned if the group is out of storage space.
"bad_request"	"too big" is returned if the photo is too large.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/addphotos

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/addphotos' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --form-string 'album_id=12' \
  --form 'fileupload=@/path/to/photo.jpg'

package main

import (
    "bytes"
    "fmt"
    "io"
    "mime/multipart"
    "net/http"
    "os"
    "path/filepath"
)

func main() {
    var requestBody bytes.Buffer
    writer := multipart.NewWriter(&requestBody)
    if err := writer.WriteField("album_id", "12"); err != nil {
        panic(err)
    }
    {
        file, err := os.Open("/path/to/photo.jpg")
        if err != nil {
            panic(err)
        }
        part, err := writer.CreateFormFile("fileupload", filepath.Base(file.Name()))
        if err != nil {
            file.Close()
            panic(err)
        }
        _, err = io.Copy(part, file)
        file.Close()
        if err != nil {
            panic(err)
        }
    }
    if err := writer.Close(); err != nil {
        panic(err)
    }
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/addphotos", &requestBody)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", writer.FormDataContentType())
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const { readFile } = await import('node:fs/promises');
    const url = new URL("https://groups.io/api/v1/addphotos");
    const body = new FormData();
    body.append("album_id", "12");
    body.append("fileupload", new Blob([await readFile("/path/to/photo.jpg")]), "photo.jpg");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 1253,
       "object": "photo",
       "created": "2020-08-30T23:30:00-07:00",
       "updated": "2023-04-23T17:44:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Store elegance joy group Senegalese",
       "desc": "Whichever happen trade move outside downstairs of exemplified up out. Destroy due taste anything where this that would whom to. Cautiously till only himself fight our whomever that for her. Our much nevertheless which numerous alone bevy as by from. E.g. otherwise laptop cloud then them yourselves few look fleet.",
       "media_type": "image/jpg",
       "size": 9234415,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 52691321,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 777,
       "object": "photo",
       "created": "2020-09-23T03:05:00-07:00",
       "updated": "2022-11-16T21:00:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "As yesterday we inquire",
       "desc": "Ourselves his laugh string several accordingly kindness bit stand woman. Just poised they enough thing homework each clothing other cry. Obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as. Out me were Norwegian significant his do mob notice lastly.",
       "media_type": "image/jpg",
       "size": 5695695,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 127437101,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1620,
       "object": "photo",
       "created": "2020-09-26T00:12:00-07:00",
       "updated": "2023-03-26T20:23:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Then result these preen numerous on",
       "desc": "Frequently him at tonight is seriously why kiss logic beyond. Him swing our Amazonian will for myself everybody I abundant. Few weekly anyone an weekly someone being that her enthusiasm. Yours never without theirs mine that delay that the air. Whatever bundle you is such batch accommodation without now in.",
       "media_type": "image/jpg",
       "size": 8923756,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 7850581,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}

View Photo List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid album_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no space"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "too big"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Photo#

POST /api/v1/updatephoto

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be the owner of the photo.

Update a photo.

POST Parameters

photo_id required integer	ID of the photo.
name optional string	The name of the photo
desc optional string	The description of the photo, in plain text format.
cover_photo optional bool	If true, make this photo the cover photo for the album.
rotate optional number	Degrees to rotate the photo, in increments of 90 degrees. Can be: 90, 180, 270, -90, -180, -270.
album_id optional integer	If provided, this moves the photo to the album. You must have permission to add photos to that album and the album must be in the same group.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid photo_id" is returned if the photo_id is missing or invalid.
"bad_request"	"invalid name" is returned if the name is invalid.
"bad_request"	"invalid desc" is returned if the desc is invalid.
"bad_request"	"invalid rotate" is returned if the rotate parameter is invalid.
"bad_request"	"invalid album_id" is returned if the album_id parameter is invalid.
"bad_request"	"no space" is returned if the group is out of space.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatephoto

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatephoto' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'photo_id=32' \
  --data-urlencode 'name=Test' \
  --data-urlencode 'desc=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("photo_id", "32")
    params.Add("name", "Test")
    params.Add("desc", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatephoto", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatephoto");
    const body = new URLSearchParams();
    body.append("photo_id", "32");
    body.append("name", "Test");
    body.append("desc", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 52691321,
   "object": "album",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "parent_album_id": 0,
   "upload_perms": "album_upload_group",
   "title": "Including tribe anything from whose market",
   "desc": "Pyramid accordingly onto moreover whenever e.g. fear usually body kilometer. Nightly child so firstly he next each secondly must catch. Politely sleepy where i.e. inquisitively yours wisp regularly nice cackle. Ourselves heavily now this our yearly what few why where. Win most would everybody them backwards this that provided store.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 24
}

View Album definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid photo_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid name"
}

"invalid name" is returned if the name is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid desc"
}

"invalid desc" is returned if the desc is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid rotate"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid album_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no space"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Photo#

GET /api/v1/getphoto

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get photo.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
album_id required integer	ID of the album that contains the photo, or 0 if viewing a photo sent as a message attachment.
photo_id required integer	ID of the photo to fetch.
attachment_num required number	If viewing a photo sent as a message attachment, this is the `attachment_num` from that photo. If `album_id` is 0, this field must be specified.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getphoto

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getphoto' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'album_id=0' \
  --data-urlencode 'photo_id=12' \
  --data-urlencode 'attachment_num=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("album_id", "0")
    params.Add("photo_id", "12")
    params.Add("attachment_num", "2")
    endpoint := "https://groups.io/api/v1/getphoto"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getphoto");
    url.searchParams.append("group_id", "12");
    url.searchParams.append("album_id", "0");
    url.searchParams.append("photo_id", "12");
    url.searchParams.append("attachment_num", "2");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 960,
   "object": "photo",
   "created": "2020-09-06T23:48:00-07:00",
   "updated": "2022-03-08T08:06:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "name": "Elegance joy group",
   "desc": "Senegalese whichever happen trade move outside downstairs of exemplified up. Out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for. Her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look.",
   "media_type": "image/jpg",
   "size": 2390440,
   "attachment_num": 0,
   "width": 0,
   "height": 0,
   "album_id": 52691321,
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "format": "jpeg",
   "focal_length": 0,
   "iso": 0,
   "aperture": 0,
   "shutter_speed": 0,
   "taken": 0,
   "make": "",
   "model": ""
}

View Photo definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid album_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid photo_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Photos#

GET /api/v1/getphotos

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getphotos

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getphotos' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getphotos"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getphotos");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 1253,
       "object": "photo",
       "created": "2020-08-30T23:30:00-07:00",
       "updated": "2023-04-23T17:44:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Store elegance joy group Senegalese",
       "desc": "Whichever happen trade move outside downstairs of exemplified up out. Destroy due taste anything where this that would whom to. Cautiously till only himself fight our whomever that for her. Our much nevertheless which numerous alone bevy as by from. E.g. otherwise laptop cloud then them yourselves few look fleet.",
       "media_type": "image/jpg",
       "size": 9234415,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 52691321,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 777,
       "object": "photo",
       "created": "2020-09-23T03:05:00-07:00",
       "updated": "2022-11-16T21:00:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "As yesterday we inquire",
       "desc": "Ourselves his laugh string several accordingly kindness bit stand woman. Just poised they enough thing homework each clothing other cry. Obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as. Out me were Norwegian significant his do mob notice lastly.",
       "media_type": "image/jpg",
       "size": 5695695,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 127437101,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1620,
       "object": "photo",
       "created": "2020-09-26T00:12:00-07:00",
       "updated": "2023-03-26T20:23:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Then result these preen numerous on",
       "desc": "Frequently him at tonight is seriously why kiss logic beyond. Him swing our Amazonian will for myself everybody I abundant. Few weekly anyone an weekly someone being that her enthusiasm. Yours never without theirs mine that delay that the air. Whatever bundle you is such batch accommodation without now in.",
       "media_type": "image/jpg",
       "size": 8923756,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 7850581,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}

View Photo List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid album_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Search Photos#

GET /api/v1/searchphotos

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/searchphotos

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/searchphotos' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'q=Test'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("q", "Test")
    endpoint := "https://groups.io/api/v1/searchphotos"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/searchphotos");
    url.searchParams.append("group_id", "12");
    url.searchParams.append("q", "Test");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 1253,
       "object": "photo",
       "created": "2020-08-30T23:30:00-07:00",
       "updated": "2023-04-23T17:44:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Store elegance joy group Senegalese",
       "desc": "Whichever happen trade move outside downstairs of exemplified up out. Destroy due taste anything where this that would whom to. Cautiously till only himself fight our whomever that for her. Our much nevertheless which numerous alone bevy as by from. E.g. otherwise laptop cloud then them yourselves few look fleet.",
       "media_type": "image/jpg",
       "size": 9234415,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 52691321,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 777,
       "object": "photo",
       "created": "2020-09-23T03:05:00-07:00",
       "updated": "2022-11-16T21:00:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "As yesterday we inquire",
       "desc": "Ourselves his laugh string several accordingly kindness bit stand woman. Just poised they enough thing homework each clothing other cry. Obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as. Out me were Norwegian significant his do mob notice lastly.",
       "media_type": "image/jpg",
       "size": 5695695,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 127437101,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1620,
       "object": "photo",
       "created": "2020-09-26T00:12:00-07:00",
       "updated": "2023-03-26T20:23:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Then result these preen numerous on",
       "desc": "Frequently him at tonight is seriously why kiss logic beyond. Him swing our Amazonian will for myself everybody I abundant. Few weekly anyone an weekly someone being that her enthusiasm. Yours never without theirs mine that delay that the air. Whatever bundle you is such batch accommodation without now in.",
       "media_type": "image/jpg",
       "size": 8923756,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 7850581,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}

View Photo List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid query"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Photo#

POST /api/v1/deletephoto

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Delete a photo.

POST Parameters

photo_id required integer	ID of the photo.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletephoto

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletephoto' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'photo_id=32'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("photo_id", "32")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletephoto", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletephoto");
    const body = new URLSearchParams();
    body.append("photo_id", "32");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid photo_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Polls

New Poll#

POST /api/v1/newpoll

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Create a new poll. The poll is created.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
question required string	The subject of the poll.
desc required string	The description of the poll, in HTML format.
announce required boolean	If `true`, send an announcement of the poll to the group.
answer required string repeated field	Possible answers to the poll. At least two must be specified.
multiple optional boolean	If `true`, allow multiple responses.
results_at_end optional boolean	If `true`, only allow results to be shown after the poll is closed.
no_results optional boolean	If `true`, do not show results.
anonymous optional boolean	If `true`, do not show who voted.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Success Responses

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newpoll

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newpoll' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'question=Test' \
  --data-urlencode 'desc=testing' \
  --data-urlencode 'answer=answer 1' \
  --data-urlencode 'answer=answer 2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("question", "Test")
    params.Add("desc", "testing")
    params.Add("answer", "answer 1")
    params.Add("answer", "answer 2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newpoll", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newpoll");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("question", "Test");
    body.append("desc", "testing");
    body.append("answer", "answer 1");
    body.append("answer", "answer 2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "anonymous": false,
   "answers": [
     {
       "answer": "",
       "selected": false
     }
   ],
   "can_view_profile": false,
   "can_view_results": false,
   "created": "2009-11-10T15:00:00-08:00",
   "desc": "",
   "group_id": 18,
   "id": 20,
   "is_closed": false,
   "msg_num": 6,
   "multiple": false,
   "name": "",
   "never_show_results": false,
   "object": "poll",
   "profile_photo_url": "",
   "question": "",
   "results": [
     {
       "answer": "",
       "count": 19,
       "percentage": "",
       "votes": [
         {
           "can_view_profile": false,
           "email": "",
           "name": "",
           "profile_photo_url": "",
           "user_id": 28
         }
       ]
     }
   ],
   "results_at_end": false,
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 68
}

View Poll definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid question"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid desc"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "not enough answers"
}

"not enough answers" is returned if there are not enough questions specified.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "need hashtag"
}

"need hashtag" is returned if a hashtag is required in the question.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "restricted hashtag"
}

"restricted hashtag" is returned if a restricted hashtag is used in the question.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "mod only hashtag"
}

"mod only hashtag" is returned if a moderator only hashtag is used in the question.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "post too big"
}

"post too big" is returned if the resulting post is too large for the group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "announce group"
}

"announce group" is returned if this poll was sent to an announcement group by a non-moderator.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Poll#

POST /api/v1/updatepoll

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Update an existing poll.

POST Parameters

poll_id required integer	ID of the poll to update.
question required string	The subject of the poll.
desc required string	The description of the poll, in HTML format.
announce required boolean	If `true`, send an announcement of the poll to the group.
answer required string repeated field	Possible answers to the poll. At least two must be specified.
edit_msg optional string	Reason for changing the poll.
multiple optional boolean	If `true`, allow multiple responses.
results_at_end optional boolean	If `true`, only allow results to be shown after the poll is closed.
no_results optional boolean	If `true`, do not show results.
anonymous optional boolean	If `true`, do not show who voted.
close optional boolean	If `true`, close the poll.
reopen optional boolean	If `true`, reopen the poll.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatepoll

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatepoll' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'poll_id=12' \
  --data-urlencode 'question=Test' \
  --data-urlencode 'desc=testing' \
  --data-urlencode 'announce=false' \
  --data-urlencode 'answer=Yes' \
  --data-urlencode 'answer=No'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("poll_id", "12")
    params.Add("question", "Test")
    params.Add("desc", "testing")
    params.Add("announce", "false")
    params.Add("answer", "Yes")
    params.Add("answer", "No")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatepoll", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatepoll");
    const body = new URLSearchParams();
    body.append("poll_id", "12");
    body.append("question", "Test");
    body.append("desc", "testing");
    body.append("announce", "false");
    body.append("answer", "Yes");
    body.append("answer", "No");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Poll definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid poll_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid question"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid desc"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "not enough answers"
}

"not enough answers" is returned if there are not enough questions specified.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "need hashtag"
}

"need hashtag" is returned if a hashtag is required in the question.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "restricted hashtag"
}

"restricted hashtag" is returned if a restricted hashtag is used in the question.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "mod only hashtag"
}

"mod only hashtag" is returned if a moderator only hashtag is used in the question.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "post too big"
}

"post too big" is returned if the resulting post is too large for the group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "announce group"
}

"announce group" is returned if this poll was sent to an announcement group by a non-moderator.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Poll#

POST /api/v1/getpoll

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Get a poll.

POST Parameters

poll_id required integer	ID of the poll to update.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/getpoll

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getpoll' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'poll_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("poll_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/getpoll", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getpoll");
    const body = new URLSearchParams();
    body.append("poll_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Poll definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid poll_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Poll Results#

POST /api/v1/getpollresults

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Get poll results.

POST Parameters

poll_id required integer	ID of the poll.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/getpollresults

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getpollresults' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'poll_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("poll_id", "12")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/getpollresults", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getpollresults");
    const body = new URLSearchParams();
    body.append("poll_id", "12");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "poll_results",
   "poll_id": 33,
   "results": [
     {
       "answer": "",
       "count": 2,
       "percentage": "",
       "votes": [
         {
           "can_view_profile": false,
           "email": "",
           "name": "",
           "profile_photo_url": "",
           "user_id": 40
         }
       ]
     }
   ]
}

View Poll Results definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid poll_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "can't view poll results"
}

"can't view poll results" is returned if the user cannot view the poll results.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Vote#

POST /api/v1/vote

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Vote in a poll.

POST Parameters

poll_id required integer	ID of the poll to update.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
answer required number	ID of the answer. Depending on the poll, you may be able to specify multiple answers.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid group_id" is returned if the group id is missing or invalid.
"bad_request"	"invalid poll_id" is returned if the poll id is missing or invalid.
"bad_request"	"no answers" is returned if no answers are specified.
"bad_request"	"poll closed" is returned if the poll has been closed.
	A `not_subscribed` error is returned if you have the `can_vote` permission through a parent group but are not directly subscribed to the group the poll is in.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/vote

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/vote' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'poll_id=12' \
  --data-urlencode 'answer=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("poll_id", "12")
    params.Add("answer", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/vote", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/vote");
    const body = new URLSearchParams();
    body.append("poll_id", "12");
    body.append("answer", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid poll_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "no answers"
}

"no answers" is returned if no answers are specified.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "poll closed"
}

"poll closed" is returned if the poll has been closed.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Reporting

This is the API endpoint for reporting content.

Report Content#

POST /api/v1/reportcontent

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be authenticated and specify an existing group. This call does not require file-upload permissions.

Report content.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
report_to required string	Where to send the report. Can be: `mods`, `support`.
reason required string	Reason for the complaint.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
message_id string	ID of the `message` object to report. One of `message_id`, `file_id`, or `photo_id` must be included in the request.
file_id string	ID of the `file` object to report. One of `message_id`, `file_id`, or `photo_id` must be included in the request.
photo_id string	ID of the `photo` object to report. One of `message_id`, `file_id`, or `photo_id` must be included in the request.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/reportcontent

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/reportcontent' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'reason=Inappropriate' \
  --data-urlencode 'message_id=321' \
  --data-urlencode 'report_to=mods'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("reason", "Inappropriate")
    params.Add("message_id", "321")
    params.Add("report_to", "mods")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/reportcontent", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/reportcontent");
    const body = new URLSearchParams();
    body.append("reason", "Inappropriate");
    body.append("message_id", "321");
    body.append("report_to", "mods");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing reason"
}

"missing reason" is returned if the reason field is missing or empty.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid report_to"
}

"invalid report_to" is returned if the report_to field is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing either message_id, photo_id, or file_id"
}

"missing either message_id, photo_id, or file_id" is returned if an appropriate ID is not included.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Sub Group Categories

Get Sub Group Categories#

GET /api/v1/getsubgroupcategories

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are "name" and "order".
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getsubgroupcategories

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getsubgroupcategories' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getsubgroupcategories"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getsubgroupcategories");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "id": 82,
       "max_subs": 3,
       "name": "example",
       "object": "sub_group_category",
       "order": 42,
       "parent_group_id": 71,
       "updated": "2009-11-10T15:00:00-08:00"
     }
   ],
   "end_item": 54,
   "has_more": false,
   "next_page_token": 99,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 28,
   "total_count": 98
}

View Sub Group Category List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Sub Groups By Category#

GET /api/v1/getsubgroupsbycategory

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get sub groups by category.

Query Parameters

group_id conditional integer	ID of the parent group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the parent group. Either `group_id` or `group_name` must be specified.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getsubgroupsbycategory

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getsubgroupsbycategory' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getsubgroupsbycategory"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getsubgroupsbycategory");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "by_category": [
     {
       "category": {
         "created": "2009-11-10T15:00:00-08:00",
         "desc": "",
         "id": 96,
         "max_subs": 28,
         "name": "example",
         "object": "sub_group_category",
         "order": 35,
         "parent_group_id": 65,
         "updated": "2009-11-10T15:00:00-08:00"
       },
       "group": {
         "id": 8658933,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "StrategyHub",
         "nice_group_name": "",
         "alias": "",
         "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
         "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
         "subject_tag": "[StrategyHub]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "invite_only": false,
         "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_by_members",
         "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,
         "two_factor_policy": "group_2fa_policy_none",
         "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,
         "ai_summaries_enabled": false,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 541,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "2020-09-07T19:38:00-07: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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "email_address": "StrategyHub@groups.io",
         "extra_member_data_columns": [
           {
             "id": 48876437,
             "name": "Text: Lots write point week doctor.",
             "type": "text_column",
             "required": true,
             "color": "color_beige",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Movement whose also it vanish watch these to ever always."
           },
           {
             "id": 161476183,
             "name": "Paragraph: Other few covey range window.",
             "type": "paragraph_column",
             "required": true,
             "color": "color_light_brown",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Silence lastly had what outcome let while school pause up."
           },
           {
             "id": 39354277,
             "name": "Checkbox: Company freedom pout his throw.",
             "type": "checkbox_column",
             "required": true,
             "color": "color_orange",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Quarterly outfit faithful is often part whom these been hourly."
           },
           {
             "id": 8897324,
             "name": "Multiple Choice: Madagascan anyway should late yours.",
             "type": "multiple_choice_column",
             "required": true,
             "color": "color_orchid",
             "choices": [
               "Monthly ball upon almost everything dynasty.",
               "Behalf shall nearly this weekly for.",
               "Anywhere everybody over secondly then boat."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Besides pack when murder her had snore first in limp."
           },
           {
             "id": 159828550,
             "name": "Date: Which these bale nobody few.",
             "type": "date_column",
             "required": true,
             "color": "color_blush",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "How anyone these string life that who result lately yourselves."
           },
           {
             "id": 185149472,
             "name": "Time: Besides later whom for rarely.",
             "type": "time_column",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Each her ski ours host our as did they to."
           },
           {
             "id": 166814414,
             "name": "Address: Bravery where this as cloud.",
             "type": "address_column",
             "required": true,
             "color": "color_cucumber",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Inside since open most you that including fight murder cautiously."
           },
           {
             "id": 102385421,
             "name": "Multi Choice: Another what full her can.",
             "type": "multi_choice_column",
             "required": true,
             "color": "color_aquamute",
             "choices": [
               "Indeed besides motherhood in that nightly.",
               "Limit we kneel herself collect yourselves.",
               "Yourselves Norwegian this fear happily fruit."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pout nature bike moreover from whoever afterwards myself mine to."
           },
           {
             "id": 154317202,
             "name": "Link: Bale sedge Christian would whose.",
             "type": "link_column",
             "required": true,
             "color": "color_military",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Hers pack rhythm that now whose her out infancy somebody."
           },
           {
             "id": 123191768,
             "name": "Image: Today scenic consequently ours eye.",
             "type": "image_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Other other abundant some anywhere this life nevertheless in next."
           },
           {
             "id": 53386358,
             "name": "HTML Paragraph: Nobody what today e.g. loss.",
             "type": "html_paragraph_column",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Spite Philippine before throughout wander of as there next of."
           },
           {
             "id": 45812071,
             "name": "Email: That because am terribly many.",
             "type": "email_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Because anyone does you hungrily can several might who monthly."
           }
         ]
       }
     }
   ],
   "subscribed": [
     {
       "category": {
         "created": "2009-11-10T15:00:00-08:00",
         "desc": "",
         "id": 89,
         "max_subs": 96,
         "name": "example",
         "object": "sub_group_category",
         "order": 47,
         "parent_group_id": 28,
         "updated": "2009-11-10T15:00:00-08:00"
       },
       "group": {
         "id": 8658933,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "StrategyHub",
         "nice_group_name": "",
         "alias": "",
         "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
         "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
         "subject_tag": "[StrategyHub]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "invite_only": false,
         "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_by_members",
         "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,
         "two_factor_policy": "group_2fa_policy_none",
         "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,
         "ai_summaries_enabled": false,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 541,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "2020-09-07T19:38:00-07: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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "email_address": "StrategyHub@groups.io",
         "extra_member_data_columns": [
           {
             "id": 48876437,
             "name": "Text: Lots write point week doctor.",
             "type": "text_column",
             "required": true,
             "color": "color_beige",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Movement whose also it vanish watch these to ever always."
           },
           {
             "id": 161476183,
             "name": "Paragraph: Other few covey range window.",
             "type": "paragraph_column",
             "required": true,
             "color": "color_light_brown",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Silence lastly had what outcome let while school pause up."
           },
           {
             "id": 39354277,
             "name": "Checkbox: Company freedom pout his throw.",
             "type": "checkbox_column",
             "required": true,
             "color": "color_orange",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Quarterly outfit faithful is often part whom these been hourly."
           },
           {
             "id": 8897324,
             "name": "Multiple Choice: Madagascan anyway should late yours.",
             "type": "multiple_choice_column",
             "required": true,
             "color": "color_orchid",
             "choices": [
               "Monthly ball upon almost everything dynasty.",
               "Behalf shall nearly this weekly for.",
               "Anywhere everybody over secondly then boat."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Besides pack when murder her had snore first in limp."
           },
           {
             "id": 159828550,
             "name": "Date: Which these bale nobody few.",
             "type": "date_column",
             "required": true,
             "color": "color_blush",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "How anyone these string life that who result lately yourselves."
           },
           {
             "id": 185149472,
             "name": "Time: Besides later whom for rarely.",
             "type": "time_column",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Each her ski ours host our as did they to."
           },
           {
             "id": 166814414,
             "name": "Address: Bravery where this as cloud.",
             "type": "address_column",
             "required": true,
             "color": "color_cucumber",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Inside since open most you that including fight murder cautiously."
           },
           {
             "id": 102385421,
             "name": "Multi Choice: Another what full her can.",
             "type": "multi_choice_column",
             "required": true,
             "color": "color_aquamute",
             "choices": [
               "Indeed besides motherhood in that nightly.",
               "Limit we kneel herself collect yourselves.",
               "Yourselves Norwegian this fear happily fruit."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pout nature bike moreover from whoever afterwards myself mine to."
           },
           {
             "id": 154317202,
             "name": "Link: Bale sedge Christian would whose.",
             "type": "link_column",
             "required": true,
             "color": "color_military",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Hers pack rhythm that now whose her out infancy somebody."
           },
           {
             "id": 123191768,
             "name": "Image: Today scenic consequently ours eye.",
             "type": "image_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Other other abundant some anywhere this life nevertheless in next."
           },
           {
             "id": 53386358,
             "name": "HTML Paragraph: Nobody what today e.g. loss.",
             "type": "html_paragraph_column",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Spite Philippine before throughout wander of as there next of."
           },
           {
             "id": 45812071,
             "name": "Email: That because am terribly many.",
             "type": "email_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Because anyone does you hungrily can several might who monthly."
           }
         ]
       }
     }
   ],
   "uncategorized": [
     {
       "id": 8658933,
       "object": "group",
       "created": "2020-09-15T11:29:00-07:00",
       "updated": "2022-02-12T18:51:00-08:00",
       "type": "group_type_messages",
       "title": "",
       "name": "StrategyHub",
       "nice_group_name": "",
       "alias": "",
       "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
       "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
       "subject_tag": "[StrategyHub]",
       "footer": "This is my\nFooter!!!!",
       "website": "",
       "announce": false,
       "moderation": "moderated",
       "new_users_moderated": true,
       "unmoderate_users_after": 3,
       "restricted": true,
       "invite_only": false,
       "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_by_members",
       "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,
       "two_factor_policy": "group_2fa_policy_none",
       "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,
       "ai_summaries_enabled": false,
       "sticky_wiki_page_id": 0,
       "sub_group_categoryid": 0,
       "subs_count": 541,
       "pending_subs_count": 0,
       "pending_msgs_count": 0,
       "open_chats_count": 0,
       "threads_count": 0,
       "messages_count": 0,
       "org_domain": "",
       "most_recent_message": "2020-09-07T19:38:00-07: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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "email_address": "StrategyHub@groups.io",
       "extra_member_data_columns": [
         {
           "id": 48876437,
           "name": "Text: Lots write point week doctor.",
           "type": "text_column",
           "required": true,
           "color": "color_beige",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Movement whose also it vanish watch these to ever always."
         },
         {
           "id": 161476183,
           "name": "Paragraph: Other few covey range window.",
           "type": "paragraph_column",
           "required": true,
           "color": "color_light_brown",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Silence lastly had what outcome let while school pause up."
         },
         {
           "id": 39354277,
           "name": "Checkbox: Company freedom pout his throw.",
           "type": "checkbox_column",
           "required": true,
           "color": "color_orange",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Quarterly outfit faithful is often part whom these been hourly."
         },
         {
           "id": 8897324,
           "name": "Multiple Choice: Madagascan anyway should late yours.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Monthly ball upon almost everything dynasty.",
             "Behalf shall nearly this weekly for.",
             "Anywhere everybody over secondly then boat."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Besides pack when murder her had snore first in limp."
         },
         {
           "id": 159828550,
           "name": "Date: Which these bale nobody few.",
           "type": "date_column",
           "required": true,
           "color": "color_blush",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "How anyone these string life that who result lately yourselves."
         },
         {
           "id": 185149472,
           "name": "Time: Besides later whom for rarely.",
           "type": "time_column",
           "required": true,
           "color": "color_sage",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Each her ski ours host our as did they to."
         },
         {
           "id": 166814414,
           "name": "Address: Bravery where this as cloud.",
           "type": "address_column",
           "required": true,
           "color": "color_cucumber",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Inside since open most you that including fight murder cautiously."
         },
         {
           "id": 102385421,
           "name": "Multi Choice: Another what full her can.",
           "type": "multi_choice_column",
           "required": true,
           "color": "color_aquamute",
           "choices": [
             "Indeed besides motherhood in that nightly.",
             "Limit we kneel herself collect yourselves.",
             "Yourselves Norwegian this fear happily fruit."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Pout nature bike moreover from whoever afterwards myself mine to."
         },
         {
           "id": 154317202,
           "name": "Link: Bale sedge Christian would whose.",
           "type": "link_column",
           "required": true,
           "color": "color_military",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Hers pack rhythm that now whose her out infancy somebody."
         },
         {
           "id": 123191768,
           "name": "Image: Today scenic consequently ours eye.",
           "type": "image_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Other other abundant some anywhere this life nevertheless in next."
         },
         {
           "id": 53386358,
           "name": "HTML Paragraph: Nobody what today e.g. loss.",
           "type": "html_paragraph_column",
           "required": true,
           "color": "color_emerald_green",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Spite Philippine before throughout wander of as there next of."
         },
         {
           "id": 45812071,
           "name": "Email: That because am terribly many.",
           "type": "email_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Because anyone does you hungrily can several might who monthly."
         }
       ]
     }
   ]
}

View Sub Groups By Category definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

User

Register User#

POST /api/v1/registeruser

Authentication: No authentication required Request: application/x-www-form-urlencoded Response: application/json

POST Parameters

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

Returns

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

Additional Errors

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

Notes

A confirmation email will be sent to the new user.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

POST /api/v1/registeruser

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/registeruser' \
  --request POST \
  --data-urlencode 'email=test@example.com' \
  --data-urlencode 'password=passw0rd'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("email", "test@example.com")
    params.Add("password", "passw0rd")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/registeruser", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/registeruser");
    const body = new URLSearchParams();
    body.append("email", "test@example.com");
    body.append("password", "passw0rd");

    const response = await fetch(url, {
        method: "POST",
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "token": "aabbffed2213234",
   "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_default"
   }
}

View Login definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get User#

GET /api/v1/getuser

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Return the user information associated with the logged in user.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getuser

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getuser' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getuser"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getuser");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "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_default"
}

View User definition

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update User#

POST /api/v1/updateuser

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

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

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
email optional string	New email address. The user object will be set to `user_status_not_confirmed` and a confirmation email will be sent out.
password optional string	New password.
timezone optional string	New timezone.
post_pref optional string	Posting preference, `user_postpref_html`, `user_postpref_plain`, `user_postpref_markdown`
per_page_pref optional string	Per page display preference, `user_per_page_pref20`, `user_per_page_pref50`, `user_per_page_pref100`, `user_per_page_pref_infinite`
time_pref optional string	How to display times, `standard_time`, `military_time`
date_pref optional string	How to display dates, `us_date`, `iso_date`, `international_date`
language_pref optional string	Language preference, `no_language_pref`, `language_english`, `language_french`, `language_german`, `language_spanish`, `language_ukrainian`, `language_italian`
dont_munge_message_id optional boolean	Whether to change the message-id of any posted messages. In the user interface, this is the "I always want copies of my own emails" checkbox.
allow_facebook_login optional boolean	Allow login to your account via Facebook.
allow_google_login optional boolean	Allow login to your account via Google.
allow_sso_login optional boolean	Allow login to your account via Single Sign On.
monday_start optional boolean	If the calendar should start on Monday (defaults to Sunday).
default_hashtag_view optional string	Set the default hashtag view. Can be: `hashtag_view_grid` or `hashtag_view_list`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updateuser

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updateuser' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'email=test@example.com'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("email", "test@example.com")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updateuser", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updateuser");
    const body = new URLSearchParams();
    body.append("email", "test@example.com");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "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_default"
}

View User definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Profile#

POST /api/v1/updateprofile

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Updates the authenticated user's profile.

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
member_info_id optional integer	To change the profile information for just one subscription, supply the member_info_id of that subscription.
full_name optional string	Your name.
user_name optional string	Your user name. Only applicable when `member_info_id` is not specified.
about_me optional string	Your about me section, in HTML format.
location optional string	Your location.
website optional string	Your website.
profile_privacy optional string	Your profile privacy setting. Can be: `profile_private`, `profile_members`, `profile_public`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updateprofile

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updateprofile' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'full_name=Joe Smith'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("full_name", "Joe Smith")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updateprofile", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updateprofile");
    const body = new URLSearchParams();
    body.append("full_name", "Joe Smith");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "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_default"
}

View User definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Profile Photo#

POST /api/v1/updateprofilephoto

Authentication: Bearer API key, Basic token, or session cookie Request: multipart/form-data Response: application/json

Updates the authenticated user's profile photo.

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
imageupload required multipart file	Multipart file upload of a new profile photo. The photo can be in GIF or JPEG format.
member_info_id optional integer	To change the profile photo for just one subscription, supply the member_info_id of that subscription.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updateprofilephoto

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updateprofilephoto' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --form 'imageupload=@/path/to/profile.jpg'

package main

import (
    "bytes"
    "fmt"
    "io"
    "mime/multipart"
    "net/http"
    "os"
    "path/filepath"
)

func main() {
    var requestBody bytes.Buffer
    writer := multipart.NewWriter(&requestBody)
    {
        file, err := os.Open("/path/to/profile.jpg")
        if err != nil {
            panic(err)
        }
        part, err := writer.CreateFormFile("imageupload", filepath.Base(file.Name()))
        if err != nil {
            file.Close()
            panic(err)
        }
        _, err = io.Copy(part, file)
        file.Close()
        if err != nil {
            panic(err)
        }
    }
    if err := writer.Close(); err != nil {
        panic(err)
    }
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updateprofilephoto", &requestBody)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", writer.FormDataContentType())
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const { readFile } = await import('node:fs/promises');
    const url = new URL("https://groups.io/api/v1/updateprofilephoto");
    const body = new FormData();
    body.append("imageupload", new Blob([await readFile("/path/to/profile.jpg")]), "profile.jpg");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "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_default"
}

View User definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Profile Photo#

POST /api/v1/deleteprofilephoto

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Deletes the authenticated user's profile photo.

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
member_info_id optional integer	To delete the profile photo for just one subscription, supply the member_info_id of that subscription.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deleteprofilephoto

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deleteprofilephoto' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode '"csrf=12345"'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("\"csrf", "12345\"")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deleteprofilephoto", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deleteprofilephoto");
    const body = new URLSearchParams();
    body.append("\"csrf", "12345\"");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "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_default"
}

View User definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Subscription#

GET /api/v1/getsub

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Get a subscription to a single group.

Query Parameters

group_id required integer	ID of the group.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getsub

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getsub' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "2")
    endpoint := "https://groups.io/api/v1/getsub"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getsub");
    url.searchParams.append("group_id", "2");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Subscriptions#

GET /api/v1/getsubs

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

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

Query Parameters

set_home_page optional boolean	If `true`, set the user's default home page to the Groups page.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Can be `group`, `approvals`, `size`, `activity`, `delivery`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getsubs

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getsubs' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'limit=2' \
  --data-urlencode 'page_token=1'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("limit", "2")
    params.Add("page_token", "1")
    endpoint := "https://groups.io/api/v1/getsubs"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getsubs");
    url.searchParams.append("limit", "2");
    url.searchParams.append("page_token", "1");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "end_item": 55,
   "has_more": false,
   "next_page_token": 9,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 50,
   "total_count": 93
}

View Member Info List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Resend Confirmation Email#

POST /api/v1/resendconfirmationemail

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

None.

Resend a confirmation email to a user with status user_status_not_confirmed.

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/resendconfirmationemail

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/resendconfirmationemail' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode '"csrf=12345"'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("\"csrf", "12345\"")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/resendconfirmationemail", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/resendconfirmationemail");
    const body = new URLSearchParams();
    body.append("\"csrf", "12345\"");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "user is not not confirmed"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Unbounce User#

POST /api/v1/unbounceuser

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

None.

Unbounce a user.

POST Parameters

csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/unbounceuser

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/unbounceuser' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/unbounceuser", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/unbounceuser");
    const body = new URLSearchParams();

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "user is not bouncing"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Subscription#

GET /api/v1/updatesub

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

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

POST Parameters

member_info_id required integer	ID of the member info object.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
email_delivery optional string	Email delivery, can be `email_delivery_single`, `email_delivery_digest`, `email_delivery_special`, `email_delivery_none`, `email_delivery_html_digest`, `email_delivery_summary`
message_selection optional string	Message selection, can be `message_selection_all`, `message_selection_follow_only`, `message_selection_follow_and_first_message`
auto_follow_replies optional boolean
max_attachment_size optional string	Maximum attachment size, can be `max_attachment_size_unlimited`, `max_attachment_size_small`, `max_attachment_size_medium`, `max_attachment_size_large`, `max_attachment_size_none`
signature optional string	Signature to be used for signing messages.
sig_format optional string	Format of the signature, can be `sig_format_html`, `sig_format_markdown`, `sig_format_plain`. Ignored if `signature` is also not specified.
use_signature optional boolean	Whether to use the signature for posts originating from the Groups.io website.
use_signature_email optional boolean	Whether to use the signature for posts originated from email.
chat_msg_notify optional string	Notify when someone posts a message to a chat you are subscribed to, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
like_notify optional string	Notify when someone likes a message you posted, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
The following are ignored if the subscription `mod_status` is `mod_status_none`.
pending_msg_notify optional string	Notify about pending messages, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
pending_sub_notify optional string	Notify about pending subscriptions, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
sub_notify optional string	Notify when someone joins the group, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
storage_notify optional string	Notify when storage limits are reached, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
sub_group_notify optional string	Notify when a subgroup is created, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
message_report_notify optional string	Notify when someone reports a message, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
chat_notify optional string	Notify when someone starts a chat, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
photo_notify optional string	Notify when someone creates a photo album or uploads a photo, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
file_notify optional string	Notify when someone creates a folder or uploads a file, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
wiki_notify optional string	Notify when someone creates or modifies a wiki page, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
database_notify optional string	Notify when someone creates or modifies a database, can be: `sub_notify_email_and_app`, `sub_notify_app_only`, `sub_notify_email_only`, `sub_notify_none`
owner_msg_notify optional string	Receive messages sent to the +owner address, can be `sub_ownermsg_notify_all`, `sub_ownermsg_notify_subs`, `sub_ownermsg_notify_none`
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/updatesub

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatesub' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/updatesub"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatesub");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

View Member Info definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Subscription#

POST /api/v1/deletesub

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Delete a subscription.

POST Parameters

group_id required	ID of the group from which you wish to unsubscribe.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Notes

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletesub

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletesub' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=2'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "2")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletesub", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletesub");
    const body = new URLSearchParams();
    body.append("group_id", "2");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Webhooks

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

Deliveries are HTTP POSTs with a User-Agent of Groups.io/Webhook and an X-Groupsio-Action header naming the action. If your subscription has a secret, deliveries also include an X-Groupsio-Signature header containing a hex HMAC-SHA256 digest of the request body, keyed with the secret.

Respond with a 2xx status code to acknowledge receipt of an event. Any other status code, or a connection failure, causes the delivery to be retried on a backoff schedule for up to approximately 45 hours, after which the event is dropped.

Webhook URLs must use http or https and must resolve to a public IP address.

New Webhook#

POST /api/v1/newwebhook

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be an owner of the group.

Create a new webhook subscription.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
url required string	The URL that `webhook_event` objects will be POSTed to. Must use http or https.
secret optional string	If specified, deliveries will include a X-Groupsio-Signature header, which is an HMAC hex digest of the body using the sha256 hash function and the secret as the HMAC key.
include_subgroups optional boolean	If `true`, events on subgroups of the group are also delivered.
actions optional string repeated field	Array of actions to be notified about, using the same names as the `action` field of the webhook event object (e.g. `joined`). If not specified, all actions are delivered.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid url" is returned if the url is missing or invalid.
"bad_request"	"invalid secret" is returned if the secret is too long.
"bad_request"	"invalid actions" is returned if an action name is not recognized.
"bad_request"	"too many webhooks" is returned if the group already has the maximum number of webhook subscriptions.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newwebhook

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newwebhook' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'url=https://example.com/webhook'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("url", "https://example.com/webhook")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newwebhook", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newwebhook");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("url", "https://example.com/webhook");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Webhook Subscription definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid url"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid secret"
}

"invalid secret" is returned if the secret is too long.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid actions"
}

"invalid actions" is returned if an action name is not recognized.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "too many webhooks"
}

"too many webhooks" is returned if the group already has the maximum number of webhook subscriptions.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Webhook#

POST /api/v1/updatewebhook

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be an owner of the group.

Update a webhook subscription.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
webhook_id required integer	ID of the webhook subscription.
url optional string	The URL that `webhook_event` objects will be POSTed to. Must use http or https. Omit to preserve the current URL.
secret optional string	If specified, deliveries will include a X-Groupsio-Signature header, which is an HMAC hex digest of the body using the sha256 hash function and the secret as the HMAC key. Omit to preserve the current secret. Pass an empty value to remove the secret.
include_subgroups optional boolean	If `true`, events on subgroups of the group are also delivered. Omit to preserve the current setting.
actions optional string repeated field	Array of actions to be notified about, using the same names as the `action` field of the webhook event object (e.g. `joined`). Omit to preserve the current actions. Pass an empty value to deliver all actions.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid webhook_id" is returned if the webhook id is missing, invalid, or belongs to another group.
"bad_request"	"invalid url" is returned if the url is invalid.
"bad_request"	"invalid secret" is returned if the secret is too long.
"bad_request"	"invalid actions" is returned if an action name is not recognized.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatewebhook

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatewebhook' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'webhook_id=34' \
  --data-urlencode 'url=https://example.com/webhook'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("webhook_id", "34")
    params.Add("url", "https://example.com/webhook")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatewebhook", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatewebhook");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("webhook_id", "34");
    body.append("url", "https://example.com/webhook");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

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

View Webhook Subscription definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid webhook_id"
}

"invalid webhook_id" is returned if the webhook id is missing, invalid, or belongs to another group.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid url"
}

"invalid url" is returned if the url is invalid.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid secret"
}

"invalid secret" is returned if the secret is too long.

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid actions"
}

"invalid actions" is returned if an action name is not recognized.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Webhooks#

GET /api/v1/getwebhooks

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

You must be an owner of the group.

Get the webhook subscriptions of a group.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are `created`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

Returns a webhook subscription list object if successful. Returns an error if there is an error.

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getwebhooks

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getwebhooks' \
  --header 'Authorization: Bearer YOUR_API_KEY'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    endpoint := "https://groups.io/api/v1/getwebhooks"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getwebhooks");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "actions": [
         "created_subgroup"
       ],
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 96,
       "id": 49,
       "include_subgroups": false,
       "object": "webhook_subscription",
       "secret": "blahblahblah",
       "updated": "2009-11-10T15:00:00-08:00",
       "url": "https://example.com/webhook"
     }
   ],
   "end_item": 70,
   "has_more": false,
   "next_page_token": 28,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 16,
   "total_count": 88
}

View Webhook Subscription List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Webhook#

POST /api/v1/deletewebhook

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

You must be an owner of the group.

Delete a webhook subscription.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
webhook_id required integer	ID of the webhook subscription.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

"bad_request"	"invalid webhook_id" is returned if the webhook id is missing, invalid, or belongs to another group.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletewebhook

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletewebhook' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'webhook_id=34'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("webhook_id", "34")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletewebhook", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletewebhook");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("webhook_id", "34");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid webhook_id"
}

"invalid webhook_id" is returned if the webhook id is missing, invalid, or belongs to another group.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Test Webhook#

POST /api/v1/testwebhook

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

You must be an owner of the group.

Send a test event to a webhook subscription.

A single webhook event with the action test_webhook is POSTed to the subscription's URL, with the same headers (including X-Groupsio-Signature if the subscription has a secret) as a real delivery. The delivery is attempted once, synchronously, with no retries.

The call succeeds even if the receiver fails; check the returned webhook test result object for the outcome.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
webhook_id required integer	ID of the webhook subscription.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

Returns a webhook test result object describing the outcome of the delivery. 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 webhook_id" is returned if the webhook id is missing, invalid, or belongs to another group.

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/testwebhook

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/testwebhook' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'webhook_id=34'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("webhook_id", "34")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/testwebhook", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/testwebhook");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("webhook_id", "34");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "error": "",
   "object": "webhook_test_result",
   "status_code": 84,
   "success": false
}

View Webhook Test Result definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid webhook_id"
}

"invalid webhook_id" is returned if the webhook id is missing, invalid, or belongs to another group.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Wikis

These are the API endpoints for wikis.

New Wiki Page#

POST /api/v1/newwikipage

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

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

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
title required string	The title of the wiki page.
body required string	The body of the wiki page, in HTML format.
locked optional boolean	If the page should be locked.
edit_msg optional string	An edit message.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/newwikipage

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/newwikipage' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'title=Test' \
  --data-urlencode 'body=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("title", "Test")
    params.Add("body", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/newwikipage", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/newwikipage");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("title", "Test");
    body.append("body", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "page": {
     "id": 52691321,
     "object": "wiki_page",
     "created": "2020-09-15T02:30:00-07:00",
     "updated": "2021-03-01T18:07:00-08:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "title": "Including tribe anything from whose market",
     "path": "Including-tribe-anything-from-whose-market",
     "locked": false,
     "rev_count": 43
   },
   "data": {
     "id": 189165006,
     "object": "wiki_data",
     "created": "2020-09-14T08:42:00-07:00",
     "updated": "2022-07-09T08:28:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Any it such so annually myself cloud these Lebanese Guyanese you herself. Greatly one being nest when itself yet unless outfit were anybody these. It envy sit too consequently which egg lastly correctly is hand early. You moreover seed those someone daily to them backwards this that provided. Store elegance joy group Senegalese whichever happen trade move outside downstairs of.\u003cbr/\u003eExemplified up out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for her our. Much nevertheless which numerous alone bevy as by from e.g. otherwise laptop. Cloud then them yourselves few look fleet say still patrol finally Vietnamese. Painting otherwise its to a e.g. congregation cackle themselves previously in for.\u003cbr/\u003eTheirs they my there road disappear accordingly hotel so today by over. Have this Romanian abroad around while belong ever into each whatever fortnightly. He agreeable sari anyone therefore does could exaltation of sit everyone they. Had mustering would as yesterday we inquire ourselves his laugh string several. Accordingly kindness bit stand woman just poised they enough thing homework each.",
     "edit_msg": "Clothing other cry"
   },
   "sidebar": {
     "id": 126768040,
     "object": "wiki_data",
     "created": "2020-09-06T17:44:00-07:00",
     "updated": "2021-07-07T18:15:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Those line over elegantly say woman pen today as now ourselves first. For without what might any where as out me were Norwegian significant. His do mob notice lastly theirs hotel one calm that later does. Point throw neatly usually Kazakh without for one from soon swing whose. Man confusing case Bangladeshi how most somewhat several week e.g. who earlier.\u003cbr/\u003eGentle catalog ourselves then tonight bend may yearly since limit e.g. besides. Chest their hair out work data sedge this might how group out. Then result these preen numerous on frequently him at tonight is seriously. Why kiss logic beyond him swing our Amazonian will for myself everybody. I abundant few weekly anyone an weekly someone being that her enthusiasm.\u003cbr/\u003eYours never without theirs mine that delay that the air whatever bundle. You is such batch accommodation without now in yearly adventurous her for. Previously as of along nobody back hers numerous would our bra yours. Union Bangladeshi Bahamian now wiggle should our example eye woman in religion. Am collapse regiment in were choir troop speed throw year work let.",
     "edit_msg": "Bunch one choir those horror would is"
   },
   "footer": {
     "id": 9000308,
     "object": "wiki_data",
     "created": "2020-09-06T02:40:00-07:00",
     "updated": "2020-10-07T01:03:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Close disregard completely decidedly which exaltation decidedly think niche annoyance yesterday hence. As him his this one into this she choir they of him. Some calm that engine our capture it that infrequently accordingly something with. Adult last often finally tonight congregation of so sneeze care massage it. Road behind recently Atlantic tea difficult were another his then afterwards finally.\u003cbr/\u003eHimself I yearly by them yet from after whom ream when fortnightly. Whose dark why besides aunt what caravan Icelandic Shakespearean theirs point spotted. Those but clap really now ourselves there rice Burmese graceful say cloud. So secondly besides moreover her sadly later several listen example answer that. Under below peacock Roman despite herself ring early outfit what are fatally.\u003cbr/\u003eRice which the door him how regularly any any key often crew. Talent it theirs disregard theirs his regularly bunch according next for French. Pretty yourselves that nutrition disregard he distinguish bones your usually as quarterly. Fondly dress pleasure ourselves my that party begin close frightening accordingly still. She outside smell hourly union anyone him leap long as had pancake.",
     "edit_msg": "Any annually gang dream without might may"
   }
}

View Wiki Page Set definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid title"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid body"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "duplicate title"
}

"duplicate title" is returned if the title is a duplicate of another wiki page.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Update Wiki Page#

POST /api/v1/updatewikipage

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: application/json

Permissions:

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

Update an existing wiki page.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
id required integer	ID of the wiki page.
title optional string	The title of the wiki page.
body optional string	The body of the wiki page, in HTML format.
locked optional boolean	If the page should be locked.
edit_msg optional string	An edit message.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/updatewikipage

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/updatewikipage' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'title=Test' \
  --data-urlencode 'body=testing'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("title", "Test")
    params.Add("body", "testing")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/updatewikipage", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/updatewikipage");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("title", "Test");
    body.append("body", "testing");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "page": {
     "id": 52691321,
     "object": "wiki_page",
     "created": "2020-09-15T02:30:00-07:00",
     "updated": "2021-03-01T18:07:00-08:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "title": "Including tribe anything from whose market",
     "path": "Including-tribe-anything-from-whose-market",
     "locked": false,
     "rev_count": 43
   },
   "data": {
     "id": 189165006,
     "object": "wiki_data",
     "created": "2020-09-14T08:42:00-07:00",
     "updated": "2022-07-09T08:28:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Any it such so annually myself cloud these Lebanese Guyanese you herself. Greatly one being nest when itself yet unless outfit were anybody these. It envy sit too consequently which egg lastly correctly is hand early. You moreover seed those someone daily to them backwards this that provided. Store elegance joy group Senegalese whichever happen trade move outside downstairs of.\u003cbr/\u003eExemplified up out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for her our. Much nevertheless which numerous alone bevy as by from e.g. otherwise laptop. Cloud then them yourselves few look fleet say still patrol finally Vietnamese. Painting otherwise its to a e.g. congregation cackle themselves previously in for.\u003cbr/\u003eTheirs they my there road disappear accordingly hotel so today by over. Have this Romanian abroad around while belong ever into each whatever fortnightly. He agreeable sari anyone therefore does could exaltation of sit everyone they. Had mustering would as yesterday we inquire ourselves his laugh string several. Accordingly kindness bit stand woman just poised they enough thing homework each.",
     "edit_msg": "Clothing other cry"
   },
   "sidebar": {
     "id": 126768040,
     "object": "wiki_data",
     "created": "2020-09-06T17:44:00-07:00",
     "updated": "2021-07-07T18:15:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Those line over elegantly say woman pen today as now ourselves first. For without what might any where as out me were Norwegian significant. His do mob notice lastly theirs hotel one calm that later does. Point throw neatly usually Kazakh without for one from soon swing whose. Man confusing case Bangladeshi how most somewhat several week e.g. who earlier.\u003cbr/\u003eGentle catalog ourselves then tonight bend may yearly since limit e.g. besides. Chest their hair out work data sedge this might how group out. Then result these preen numerous on frequently him at tonight is seriously. Why kiss logic beyond him swing our Amazonian will for myself everybody. I abundant few weekly anyone an weekly someone being that her enthusiasm.\u003cbr/\u003eYours never without theirs mine that delay that the air whatever bundle. You is such batch accommodation without now in yearly adventurous her for. Previously as of along nobody back hers numerous would our bra yours. Union Bangladeshi Bahamian now wiggle should our example eye woman in religion. Am collapse regiment in were choir troop speed throw year work let.",
     "edit_msg": "Bunch one choir those horror would is"
   },
   "footer": {
     "id": 9000308,
     "object": "wiki_data",
     "created": "2020-09-06T02:40:00-07:00",
     "updated": "2020-10-07T01:03:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Close disregard completely decidedly which exaltation decidedly think niche annoyance yesterday hence. As him his this one into this she choir they of him. Some calm that engine our capture it that infrequently accordingly something with. Adult last often finally tonight congregation of so sneeze care massage it. Road behind recently Atlantic tea difficult were another his then afterwards finally.\u003cbr/\u003eHimself I yearly by them yet from after whom ream when fortnightly. Whose dark why besides aunt what caravan Icelandic Shakespearean theirs point spotted. Those but clap really now ourselves there rice Burmese graceful say cloud. So secondly besides moreover her sadly later several listen example answer that. Under below peacock Roman despite herself ring early outfit what are fatally.\u003cbr/\u003eRice which the door him how regularly any any key often crew. Talent it theirs disregard theirs his regularly bunch according next for French. Pretty yourselves that nutrition disregard he distinguish bones your usually as quarterly. Fondly dress pleasure ourselves my that party begin close frightening accordingly still. She outside smell hourly union anyone him leap long as had pancake.",
     "edit_msg": "Any annually gang dream without might may"
   }
}

View Wiki Page Set definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid title"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid body"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "duplicate title"
}

"duplicate title" is returned if the title is a duplicate of another wiki page.

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Wiki Page#

POST /api/v1/deletewikipage

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Delete an existing wiki page.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
id required integer	ID of the wiki page.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletewikipage

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletewikipage' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'id=10'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("id", "10")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletewikipage", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletewikipage");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("id", "10");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Delete Wiki Page Revision#

POST /api/v1/deletewikirevision

Authentication: Bearer API key, Basic token, or session cookie Request: application/x-www-form-urlencoded Response: HTTP 200 · empty body

Permissions:

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

Delete an existing wiki page revision.

POST Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
id required integer	ID of the wiki page.
data_id required integer	ID of the wiki data object to delete.
csrf conditional string	Required only with cookie authentication. Send the `csrf_token` from the user as `csrf`. Omit with a Bearer API key or HTTP Basic authentication token.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

POST /api/v1/deletewikirevision

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/deletewikirevision' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --request POST \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'id=10' \
  --data-urlencode 'data_id=1'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("id", "10")
    params.Add("data_id", "1")
    req, err := http.NewRequest("POST", "https://groups.io/api/v1/deletewikirevision", strings.NewReader(params.Encode()))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/deletewikirevision");
    const body = new URLSearchParams();
    body.append("group_id", "12");
    body.append("id", "10");
    body.append("data_id", "1");

    const response = await fetch(url, {
        method: "POST",
        headers: { Authorization: "Bearer YOUR_API_KEY" },
        body
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · Empty body

The successful response has no body. Check the HTTP status before decoding JSON.

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object as its only element: [user].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid group_id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid data_id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Wiki Pages#

GET /api/v1/getwikipages

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

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

Query Parameters

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

Returns

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

Additional Errors

No additional errors

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getwikipages

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getwikipages' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    endpoint := "https://groups.io/api/v1/getwikipages"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getwikipages");
    url.searchParams.append("group_id", "12");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "wiki_page",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "Including tribe anything from whose",
       "path": "Including-tribe-anything-from-whose",
       "locked": false,
       "rev_count": 30
     },
     {
       "id": 29743360,
       "object": "wiki_page",
       "created": "2020-10-01T09:06:00-07:00",
       "updated": "2022-06-06T16:00:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "Yourself any it such so",
       "path": "Yourself-any-it-such-so",
       "locked": false,
       "rev_count": 37
     },
     {
       "id": 83034458,
       "object": "wiki_page",
       "created": "2020-09-14T20:59:00-07:00",
       "updated": "2022-11-29T01:40:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "E.g. fear usually",
       "path": "E.g.-fear-usually",
       "locked": false,
       "rev_count": 1
     }
   ]
}

View Wiki Page List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Get Wiki Page Set#

GET /api/v1/getwikipageset

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Get wiki page set.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` must be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` must be specified.
path conditional string	Path of wiki page. Either `path` or `id` must be specified.
id conditional integer	ID of the wiki page to fetch. Either `path` or `id` must be specified.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/getwikipageset

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/getwikipageset' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'path=test'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("path", "test")
    endpoint := "https://groups.io/api/v1/getwikipageset"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/getwikipageset");
    url.searchParams.append("group_id", "12");
    url.searchParams.append("path", "test");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "page": {
     "id": 52691321,
     "object": "wiki_page",
     "created": "2020-09-15T02:30:00-07:00",
     "updated": "2021-03-01T18:07:00-08:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "title": "Including tribe anything from whose market",
     "path": "Including-tribe-anything-from-whose-market",
     "locked": false,
     "rev_count": 43
   },
   "data": {
     "id": 189165006,
     "object": "wiki_data",
     "created": "2020-09-14T08:42:00-07:00",
     "updated": "2022-07-09T08:28:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Any it such so annually myself cloud these Lebanese Guyanese you herself. Greatly one being nest when itself yet unless outfit were anybody these. It envy sit too consequently which egg lastly correctly is hand early. You moreover seed those someone daily to them backwards this that provided. Store elegance joy group Senegalese whichever happen trade move outside downstairs of.\u003cbr/\u003eExemplified up out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for her our. Much nevertheless which numerous alone bevy as by from e.g. otherwise laptop. Cloud then them yourselves few look fleet say still patrol finally Vietnamese. Painting otherwise its to a e.g. congregation cackle themselves previously in for.\u003cbr/\u003eTheirs they my there road disappear accordingly hotel so today by over. Have this Romanian abroad around while belong ever into each whatever fortnightly. He agreeable sari anyone therefore does could exaltation of sit everyone they. Had mustering would as yesterday we inquire ourselves his laugh string several. Accordingly kindness bit stand woman just poised they enough thing homework each.",
     "edit_msg": "Clothing other cry"
   },
   "sidebar": {
     "id": 126768040,
     "object": "wiki_data",
     "created": "2020-09-06T17:44:00-07:00",
     "updated": "2021-07-07T18:15:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Those line over elegantly say woman pen today as now ourselves first. For without what might any where as out me were Norwegian significant. His do mob notice lastly theirs hotel one calm that later does. Point throw neatly usually Kazakh without for one from soon swing whose. Man confusing case Bangladeshi how most somewhat several week e.g. who earlier.\u003cbr/\u003eGentle catalog ourselves then tonight bend may yearly since limit e.g. besides. Chest their hair out work data sedge this might how group out. Then result these preen numerous on frequently him at tonight is seriously. Why kiss logic beyond him swing our Amazonian will for myself everybody. I abundant few weekly anyone an weekly someone being that her enthusiasm.\u003cbr/\u003eYours never without theirs mine that delay that the air whatever bundle. You is such batch accommodation without now in yearly adventurous her for. Previously as of along nobody back hers numerous would our bra yours. Union Bangladeshi Bahamian now wiggle should our example eye woman in religion. Am collapse regiment in were choir troop speed throw year work let.",
     "edit_msg": "Bunch one choir those horror would is"
   },
   "footer": {
     "id": 9000308,
     "object": "wiki_data",
     "created": "2020-09-06T02:40:00-07:00",
     "updated": "2020-10-07T01:03:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Close disregard completely decidedly which exaltation decidedly think niche annoyance yesterday hence. As him his this one into this she choir they of him. Some calm that engine our capture it that infrequently accordingly something with. Adult last often finally tonight congregation of so sneeze care massage it. Road behind recently Atlantic tea difficult were another his then afterwards finally.\u003cbr/\u003eHimself I yearly by them yet from after whom ream when fortnightly. Whose dark why besides aunt what caravan Icelandic Shakespearean theirs point spotted. Those but clap really now ourselves there rice Burmese graceful say cloud. So secondly besides moreover her sadly later several listen example answer that. Under below peacock Roman despite herself ring early outfit what are fatally.\u003cbr/\u003eRice which the door him how regularly any any key often crew. Talent it theirs disregard theirs his regularly bunch according next for French. Pretty yourselves that nutrition disregard he distinguish bones your usually as quarterly. Fondly dress pleasure ourselves my that party begin close frightening accordingly still. She outside smell hourly union anyone him leap long as had pancake.",
     "edit_msg": "Any annually gang dream without might may"
   }
}

View Wiki Page Set definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid path"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "invalid id"
}

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

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing path and id"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Search Wikis#

GET /api/v1/searchwikis

Authentication: Bearer API key, Basic token, or session cookie Request: Query string Response: application/json

Permissions:

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

Search the wiki.

Query Parameters

group_id conditional integer	ID of the group. Either `group_id` or `group_name` can be specified.
group_name conditional string	Name of the group. Either `group_id` or `group_name` can be specified.
q required string	The query string.
limit optional integer	A limit on the number of objects to be returned, between 1 and 100. Default: `10` Minimum: 1 Maximum: 100
page_token optional opaque cursor	A cursor for use in pagination. To fetch the next page, set `page_token` to the value of the `next_page_token` response.
sort_field optional string	The field to sort on. Valid values are `created`, `title`.
sort_dir optional string	Sort direction. Can be `asc` or `desc`.
extended optional boolean	If `true`, the endpoint will return additional information. See Extended Return Information for more information.

Returns

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

Additional Errors

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

Request example

Edit request

Checked fields are sent. Unchecked fields are omitted. A checked empty value sends an empty string. File values are local paths used by the generated code.

These examples use a Bearer API key, so a CSRF token is unnecessary.

GET /api/v1/searchwikis

curl --fail-with-body --silent --show-error 'https://groups.io/api/v1/searchwikis' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --get \
  --data-urlencode 'group_id=12' \
  --data-urlencode 'q=find this'

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    params := url.Values{}
    params.Add("group_id", "12")
    params.Add("q", "find this")
    endpoint := "https://groups.io/api/v1/searchwikis"
    if query := params.Encode(); query != "" {
        endpoint += "?" + query
    }
    req, err := http.NewRequest("GET", endpoint, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode < 200 || resp.StatusCode >= 300 {
        body, _ := io.ReadAll(resp.Body)
        panic(fmt.Sprintf("HTTP %d: %s", resp.StatusCode, body))
    }
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

// Node.js 18+ (fetch is built in).
async function callAPI() {
    const url = new URL("https://groups.io/api/v1/searchwikis");
    url.searchParams.append("group_id", "12");
    url.searchParams.append("q", "find this");

    const response = await fetch(url, {
        method: "GET",
        headers: { Authorization: "Bearer YOUR_API_KEY" }
    });
    if (!response.ok) {
        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
    }
    const text = await response.text();
    const data = text ? JSON.parse(text) : null;
    console.log(data ?? 'Success (empty response)');
}

callAPI().catch(console.error);

Example 200 · application/json · Success

 {
   "data": [
     {
       "body": "",
       "created": "2009-11-10T15:00:00-08:00",
       "data_id": 57,
       "edit_msg": "",
       "group_id": 44,
       "id": 18,
       "object": "wiki_search_result",
       "rev_count": 78,
       "snippet": "",
       "title": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 88
     }
   ],
   "end_item": 32,
   "group_id": 45,
   "has_more": false,
   "next_page_token": 26,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 44,
   "total_count": 13
}

View Wiki Search Results List definition

Example 200 · application/json · Extended response

With extended=true, the response is a JSON array containing the User Object followed by the successful result shown above: [user, result].

Example 400 · application/json · bad_request

{
  "object": "error",
  "type": "bad_request",
  "extra": "missing query"
}

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

Example 400 · application/json · General errors

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

See general errors for authentication and permission failures.

Example 429 · Empty body · Rate limited

No JSON error object is returned. Back off before retrying; see Errors.

Objects

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

The Activity Log Object#

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

Response Attributes

id integer	ID of the draft attachment object.
object string	activity_log.
created string date-time
group_id integer	ID of the group.
entry string	The log entry, in HTML format.
via string	How the log entry was generated. Can be one of: `via_api`, `via_app`, `via_email`, `via_robot`, `via_slacksync`, `via_support`, `via_web`.

Example Object

{
   "id": 52691321,
   "object": "activity_log",
   "created": "2020-09-15T02:30:00-07:00",
   "group_id": 8658933,
   "entry": "Integration \"testintegration\" sent  special notice #32",
   "via": "via_robot"
}

The Activity Log List Object#

Activity Log List

Response Attributes

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

Methods That Use This Object

Get Activity Log	View Method

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "activity_log",
       "created": "2020-09-02T00:51:00-07:00",
       "group_id": 8658933,
       "entry": "Integration \"testintegration\" sent  special notice #0",
       "via": "via_robot"
     },
     {
       "id": 10192753,
       "object": "activity_log",
       "created": "2020-08-30T23:30:00-07:00",
       "group_id": 8658933,
       "entry": "Integration \"testintegration\" sent  special notice #1",
       "via": "via_robot"
     },
     {
       "id": 122478329,
       "object": "activity_log",
       "created": "2020-10-01T15:33:00-07:00",
       "group_id": 8658933,
       "entry": "Integration \"testintegration\" sent  special notice #2",
       "via": "via_robot"
     }
   ]
}

The Add Error Object#

The direct add results error object.

Response Attributes

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

Example Object

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

The Album Object#

The album object.

Response Attributes

id integer	Unique ID of the album object.
object string	album.
created string date-time
updated string date-time
user_id integer
group_id integer
parent_album_id integer	ID of parent album (0 = root level).
upload_perms string
title string	Title of the album.
desc string	Description of the album in plain text.
display_name string	Name of the person who uploaded the photo.
user_name string	User name of the person who uploaded the photo.
profile_photo_url optional string	URL of the profile photo of the person who uploaded the photo.
profile_privacy string	Privacy setting of the person who uploaded the photo.
email string	Possibly obscured, depending on group settings.
cover_photo_thumbnail_url optional string	Thumbnail of cover photo.
cover_photo_url optional string	Photo to display.
total_photos optional integer	How many photos in album.

Methods That Use This Object

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

Example Object

{
   "id": 52691321,
   "object": "album",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "parent_album_id": 0,
   "upload_perms": "album_upload_group",
   "title": "Including tribe anything from whose market",
   "desc": "Pyramid accordingly onto moreover whenever e.g. fear usually body kilometer. Nightly child so firstly he next each secondly must catch. Politely sleepy where i.e. inquisitively yours wisp regularly nice cackle. Ourselves heavily now this our yearly what few why where. Win most would everybody them backwards this that provided store.",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "total_photos": 24
}

The Album List Object#

Album List

Response Attributes

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

Methods That Use This Object

Get Photo Albums	View Method

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "album",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "parent_album_id": 0,
       "upload_perms": "album_upload_group",
       "title": "Including tribe anything from whose",
       "desc": "Market pyramid accordingly onto moreover whenever e.g. fear usually body. Kilometer nightly child so firstly he next each secondly must. Catch politely sleepy where i.e. inquisitively yours wisp regularly nice. Cackle ourselves heavily now this our yearly what few why. Where win most would everybody them backwards this that provided.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 18
     },
     {
       "id": 134723079,
       "object": "album",
       "created": "2020-10-01T09:06:00-07:00",
       "updated": "2022-06-06T16:00:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "parent_album_id": 0,
       "upload_perms": "album_upload_group",
       "title": "Whom I company Roman indeed",
       "desc": "Words trade move outside downstairs of exemplified up out destroy. Due taste anything where this that would whom to cautiously. Till only himself fight our whomever that for her our. Much nevertheless which numerous alone bevy as by from e.g.. Otherwise laptop cloud then them yourselves few look fleet say.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 27
     },
     {
       "id": 112832928,
       "object": "album",
       "created": "2020-09-14T20:59:00-07:00",
       "updated": "2022-11-29T01:40:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "parent_album_id": 0,
       "upload_perms": "album_upload_group",
       "title": "Cruelly rarely over",
       "desc": "By otherwise its to a e.g. congregation cackle themselves previously. In for theirs they my there road disappear accordingly hotel. So today by over have this Romanian abroad around while. Belong ever into each whatever fortnightly he agreeable sari anyone. Therefore does could exaltation of sit everyone they had mustering.",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "total_photos": 13
     }
   ]
}

The Bounce Info Object#

The bounce info object.

Response Attributes

object string	bounce_info.
created string date-time
group_id integer	ID of the group.
msg_id integer	Message ID of the message we were attempting to send.
subject string	Subject of the message we were attempting to send.
response string	Response from the recipient server.
is_hard boolean	If the bounce was a hard bounce.
type string	Can be one of: `delivery_bounce_probe`, `delivery_confirm_pending`, `delivery_confirmation`, `delivery_digest`, `delivery_direct_add`, `delivery_invite`, `delivery_login_link`, `delivery_member_notice`, `delivery_mod_notice`, `delivery_reply`, `delivery_reverify`, `delivery_single`, `delivery_summary`, `delivery_to_owner`, `delivery_to_sub`.

Example Object

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

The Bounce Info List Object#

Bounce Info List

Response Attributes

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

Methods That Use This Object

Get Bounce Info	View Method

Example Object

{
   "data": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 41,
       "is_hard": false,
       "msg_id": 21,
       "object": "bounce_info",
       "response": "",
       "subject": "",
       "type": "delivery_bounce_probe"
     }
   ],
   "end_item": 1,
   "has_more": false,
   "next_page_token": 43,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 60,
   "total_count": 31
}

The Bulk Remove Results Object#

Results of a bulk member removal. Errors are reported individually by email address.

Response Attributes

object string	bulk_remove_results.
errors array of Remove Error objects nullable
total_emails integer
removed integer

Methods That Use This Object

Bulk Remove Members	View Method

Example Object

{
   "errors": [
     {
       "email": "",
       "object": "remove_error",
       "status": "bulk_remove_db_error"
     }
   ],
   "object": "bulk_remove_results",
   "removed": 13,
   "total_emails": 0
}

The Chat Object#

The chat object.

Response Attributes

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

Methods That Use This Object

New Chat	View Method
Update Chat	View Method

Example Object

{
   "id": 52691321,
   "object": "chat",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "profile_photo_url": "",
   "name": "",
   "can_view_profile": false,
   "group_id": 8658933,
   "subject": "Including.",
   "desc": "Tribe anything from.",
   "is_closed": false,
   "num_messages": 21,
   "chat_sub": {
     "id": 179889653,
     "object": "chat_sub",
     "created": "2020-09-10T11:42:00-07:00",
     "updated": "2023-03-29T23:48:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "chat_id": 52691321,
     "last_msg_seen": 40
   }
}

The Chat List Object#

Chat List

Response Attributes

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

Methods That Use This Object

Get Chats	View Method

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "chat",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Including.",
       "desc": "Tribe anything from.",
       "is_closed": false,
       "num_messages": 21,
       "chat_sub": {
         "id": 179889653,
         "object": "chat_sub",
         "created": "2020-09-29T17:03:00-07:00",
         "updated": "2022-06-18T23:30:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 52691321,
         "last_msg_seen": 40
       }
     },
     {
       "id": 195168922,
       "object": "chat",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Pyramid.",
       "desc": "Accordingly onto moreover.",
       "is_closed": false,
       "num_messages": 81,
       "chat_sub": {
         "id": 83034458,
         "object": "chat_sub",
         "created": "2020-09-06T02:40:00-07:00",
         "updated": "2020-10-07T01:03:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 195168922,
         "last_msg_seen": 90
       }
     },
     {
       "id": 182971401,
       "object": "chat",
       "created": "2020-09-24T00:10:00-07:00",
       "updated": "2021-05-19T19:29:00-07:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Fear.",
       "desc": "Usually body kilometer.",
       "is_closed": false,
       "num_messages": 198,
       "chat_sub": {
         "id": 122478329,
         "object": "chat_sub",
         "created": "2020-08-30T21:35:00-07:00",
         "updated": "2023-05-02T01:56:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 182971401,
         "last_msg_seen": 84
       }
     }
   ]
}

The Chat Message Object#

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

Response Attributes

id integer	Unique ID of the chat_message object.
object string	chat_message.
created string date-time
version integer	The version of this object. Used to detect server upgrades to force reload of the app. The current version is 2.
user_id integer	ID of the person who is subscribed.
group_id integer	ID of the group the chat is in.
chat_id integer	ID of the chat.
type string	Type of message. Can be one of: `chat_msg_type_blur`, `chat_msg_type_closed`, `chat_msg_type_delete`, `chat_msg_type_first`, `chat_msg_type_focus`, `chat_msg_type_joined`, `chat_msg_type_left`, `chat_msg_type_normal`, `chat_msg_type_photo`, `chat_msg_type_removed`, `chat_msg_type_typing`, `chat_msg_type_update_tapbacks`, `chat_msg_type_video`.
message string	The chat message itself (dependant on the Type of chat message), in HTML format.
msg_num integer	The message number, increases monotonically from 1.
reply_message optional Chat Message object	If this message is a reply, this is the message that it's replying to.
delete_msg_num integer	If this is a delete message, this is the ID to delete.
media array of Chat Message Media objects nullable
tapbacks array of Chat Message Tapback objects nullable
tapback_counts array of Chat Message Tapback Count objects nullable
display_name string
user_name string
profile_photo_url string
profile_privacy string	Privacy setting of the sender of the message.
profile_color string	Color to use when displaying the sender's name, in hex.
email string	Possibly obscured, depending on group settings.

Example Object

{
   "id": 179889653,
   "object": "chat_message",
   "created": "2020-09-10T11:42:00-07:00",
   "version": 5,
   "user_id": 147779411,
   "group_id": 8658933,
   "chat_id": 52691321,
   "type": "chat_msg_type_normal",
   "message": "Market pyramid accordingly onto moreover whenever e.g. fear..",
   "msg_num": 179889653,
   "delete_msg_num": 0,
   "media": null,
   "tapbacks": null,
   "tapback_counts": null,
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_photo_url": "https://picsum.photos/id/53/498/325",
   "profile_privacy": "profile_private",
   "profile_color": "#837fd5",
   "email": "gersonbeahan@..."
}

The Chat Message List Object#

Chat Message List

Response Attributes

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

Methods That Use This Object

Get Chat History	View Method

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 179889653,
       "object": "chat_message",
       "created": "2020-09-29T17:03:00-07:00",
       "version": 5,
       "user_id": 147779411,
       "group_id": 8658933,
       "chat_id": 52691321,
       "type": "chat_msg_type_normal",
       "message": "Market pyramid..",
       "msg_num": 179889653,
       "delete_msg_num": 0,
       "media": null,
       "tapbacks": [
         {
           "user_id": 51506187,
           "sub_id": 14243141,
           "type": "chat_msg_tapback_thumbs_up"
         },
         {
           "user_id": 97752942,
           "sub_id": 10287162,
           "type": "chat_msg_tapback_laugh"
         }
       ],
       "tapback_counts": [
         {
           "type": "chat_msg_tapback_heart",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_thumbs_up",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_thumbs_down",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_laugh",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_exclamation",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_question",
           "count": 0
         }
       ],
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://picsum.photos/id/53/498/325",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 154675724,
       "object": "chat_message",
       "created": "2020-09-14T23:24:00-07:00",
       "version": 5,
       "user_id": 147779411,
       "group_id": 8658933,
       "chat_id": 10192753,
       "type": "chat_msg_type_normal",
       "message": "Lebanese Guyanese you herself greatly one being nest. When itself yet unless outfit were anybody these.",
       "msg_num": 154675724,
       "delete_msg_num": 0,
       "media": null,
       "tapbacks": [
         {
           "user_id": 196646336,
           "sub_id": 144338940,
           "type": "chat_msg_tapback_question"
         },
         {
           "user_id": 123317449,
           "sub_id": 174167102,
           "type": "chat_msg_tapback_heart"
         },
         {
           "user_id": 115712626,
           "sub_id": 20535086,
           "type": "chat_msg_tapback_thumbs_down"
         },
         {
           "user_id": 92539812,
           "sub_id": 54982055,
           "type": "chat_msg_tapback_thumbs_down"
         },
         {
           "user_id": 110808615,
           "sub_id": 161817060,
           "type": "chat_msg_tapback_laugh"
         },
         {
           "user_id": 89933098,
           "sub_id": 19594331,
           "type": "chat_msg_tapback_heart"
         }
       ],
       "tapback_counts": [
         {
           "type": "chat_msg_tapback_heart",
           "count": 2
         },
         {
           "type": "chat_msg_tapback_thumbs_up",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_thumbs_down",
           "count": 2
         },
         {
           "type": "chat_msg_tapback_laugh",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_exclamation",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_question",
           "count": 1
         }
       ],
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://picsum.photos/id/53/498/325",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "chat_message",
       "created": "2020-09-20T09:51:00-07:00",
       "version": 5,
       "user_id": 147779411,
       "group_id": 8658933,
       "chat_id": 137070462,
       "type": "chat_msg_type_normal",
       "message": "What few why where win most would everybody them backwards this that. Provided store elegance joy group Senegalese whichever happen trade move outside downstairs. Of exemplified up out destroy due taste anything where this that would. Whom to cautiously till only himself fight our whomever that for her. Our much nevertheless which numerous alone bevy as by from e.g. otherwise. Laptop cloud then them yourselves few look fleet say still patrol finally. Vietnamese painting otherwise its to a e.g. congregation cackle themselves previously in. For theirs they my there road disappear accordingly hotel so today by. Over have this Romanian abroad around while belong ever into each whatever.",
       "msg_num": 189377967,
       "delete_msg_num": 0,
       "media": null,
       "tapbacks": [
         {
           "user_id": 91729622,
           "sub_id": 141481456,
           "type": "chat_msg_tapback_laugh"
         },
         {
           "user_id": 55138761,
           "sub_id": 139522588,
           "type": "chat_msg_tapback_thumbs_up"
         }
       ],
       "tapback_counts": [
         {
           "type": "chat_msg_tapback_heart",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_thumbs_up",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_thumbs_down",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_laugh",
           "count": 1
         },
         {
           "type": "chat_msg_tapback_exclamation",
           "count": 0
         },
         {
           "type": "chat_msg_tapback_question",
           "count": 0
         }
       ],
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://picsum.photos/id/53/498/325",
       "profile_privacy": "profile_private",
       "profile_color": "#837fd5",
       "email": "gersonbeahan@..."
     }
   ]
}

The Chat Message Media Object#

Chat Message Media

Response Attributes

name string	name of the photo or video.
type string	mime media type, if a photo or video.
size integer
width integer
height integer
url string
gallery_url string

Example Object

{
   "gallery_url": "",
   "height": 48,
   "name": "",
   "size": 29,
   "type": "",
   "url": "",
   "width": 70
}

The Chat Message Tapback Object#

Chat Message Tapback

Response Attributes

user_id integer
sub_id integer
type string

Example Object

{
   "sub_id": 64,
   "type": "",
   "user_id": 96
}

The Chat Message Tapback Count Object#

Chat Message Tapback Count

Response Attributes

type string
count integer

Example Object

{
   "count": 26,
   "type": ""
}

The Chat Sub Object#

The chat subscription object.

Response Attributes

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

Methods That Use This Object

Join Chat	View Method

Example Object

{
   "id": 179889653,
   "object": "chat_sub",
   "created": "2020-09-10T11:42:00-07:00",
   "updated": "2023-03-29T23:48:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "chat_id": 52691321,
   "last_msg_seen": 40
}

The Database Column Object#

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

Response Attributes

id integer	Column ID.
name string	Name of the column.
type string	The column type. Can be one of: `address_column`, `checkbox_column`, `date_column`, `email_column`, `github_id_column`, `html_paragraph_column`, `image_column`, `link_column`, `multi_choice_column`, `multiple_choice_column`, `number_column`, `paragraph_column`, `text_column`, `time_column`.
required boolean	The column cannot be empty.
color string	Color of the row. Can be one of: `color_antique_pink`, `color_apricot`, `color_aquamute`, `color_beige`, `color_bluejean`, `color_blush`, `color_burnt_yellow`, `color_capri_blue`, `color_cerulean_blue`, `color_cherry_blossom`, `color_cloudy_blue`, `color_cucumber`, `color_dark_grey`, `color_dark_orange`, `color_dusty_mauve`, `color_emerald_green`, `color_grape`, `color_green_lantern`, `color_green_sage`, `color_grey_blue`, `color_light_brown`, `color_light_grey`, `color_light_lilac`, `color_lilac`, `color_lips`, `color_melon`, `color_military`, `color_moss_green`, `color_mulbery`, `color_mustard`, `color_none`, `color_orange`, `color_orchid`, `color_peony`, `color_pink`, `color_purple`, `color_purple_blue`, `color_purple_grey`, `color_sage`, `color_sky`, `color_terracotta`, `color_tomato`, `color_yellow`.
choices optional array of string	Titles of the choices for `multi_choice` and `multiple_choice` columns.
width integer	Width of the column (0 means not set/use the default).
default_hidden boolean	The column should be hidden when you view the table initially.
profile optional boolean	If this column is a part of a member's profile, only used for extra member data columns.
description string	Description of this column.
default_country optional string	For address columns, the default country.
exclude_street optional boolean	For address columns, if we should exclude street fields.
exclude_city optional boolean	For address columns, if we should exclude the city field.
exclude_state optional boolean	For address columns, if we should exclude the state field.
exclude_zip optional boolean	For address columns, if we should exclude the zip field.
exclude_country optional boolean	For address columns, if we should exclude the country field.

Example Object

{
   "id": 52691321,
   "name": "Multiple Choice: Including tribe anything from whose.",
   "type": "multiple_choice_column",
   "required": true,
   "color": "color_orchid",
   "choices": [
     "Next each secondly must catch politely.",
     "Sleepy where i.e. inquisitively yours wisp.",
     "Regularly nice cackle ourselves heavily now."
   ],
   "width": 0,
   "default_hidden": false,
   "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
}

The Database Row Object#

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

Response Attributes

id integer	Row ID.
object string	databaserow.
created string date-time	Time that this row was first created.
updated string date-time	Time that this row was last updated.
group_id integer	ID of the group.
table_id integer	ID of the `database_table` object.
row_num integer	The table's max_row_id at the time of row creation.
vals array of Database Value objects nullable	Values for each column.
num_vals integer	Number of values.

Methods That Use This Object

Add Database Row	View Method
Update Database Row	View Method

Example Object

{
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 78,
   "id": 89,
   "num_vals": 98,
   "object": "databaserow",
   "row_num": 72,
   "table_id": 64,
   "updated": "2009-11-10T15:00:00-08:00",
   "vals": [
     {
       "checked": false,
       "city": "",
       "col_id": 7,
       "col_type": "address_column",
       "country": "",
       "date": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "github_avatar_url": "",
       "github_bio": "",
       "github_company": "",
       "github_email": "",
       "github_id": 83,
       "github_location": "",
       "github_login": "",
       "github_name": "",
       "github_profile_url": "",
       "html_text": "",
       "image_data": [
         ""
       ],
       "image_name": "",
       "lat": 3.2,
       "lng": 3.2,
       "multi_choice": [
         98
       ],
       "number": 3.2,
       "state": "",
       "street_address1": "",
       "street_address2": "",
       "text": "",
       "time": "2009-11-10T15:00:00-08:00",
       "title": "",
       "url": "",
       "zip": ""
     }
   ]
}

The Database Row List Object#

Database Row List

Response Attributes

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

Methods That Use This Object

Get Database Rows	View Method

Example Object

{
   "data": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 91,
       "id": 59,
       "num_vals": 71,
       "object": "databaserow",
       "row_num": 66,
       "table_id": 24,
       "updated": "2009-11-10T15:00:00-08:00",
       "vals": [
         {
           "checked": false,
           "city": "",
           "col_id": 78,
           "col_type": "address_column",
           "country": "",
           "date": "2009-11-10T15:00:00-08:00",
           "desc": "",
           "github_avatar_url": "",
           "github_bio": "",
           "github_company": "",
           "github_email": "",
           "github_id": 64,
           "github_location": "",
           "github_login": "",
           "github_name": "",
           "github_profile_url": "",
           "html_text": "",
           "image_data": [
             ""
           ],
           "image_name": "",
           "lat": 3.2,
           "lng": 3.2,
           "multi_choice": [
             17
           ],
           "number": 3.2,
           "state": "",
           "street_address1": "",
           "street_address2": "",
           "text": "",
           "time": "2009-11-10T15:00:00-08:00",
           "title": "",
           "url": "",
           "zip": ""
         }
       ]
     }
   ],
   "end_item": 42,
   "has_more": false,
   "next_page_token": 31,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 79,
   "total_count": 62
}

The Database Table Object#

The database table object.

Response Attributes

id integer
object string	databasetable.
created string date-time
updated string date-time
group_id integer
user_id integer	Who originally created this table.
name string	Name of table.
short_desc string
desc string
desc_type string	html, plain, markdown.
edit_table string	Can be one of: `database_access_all`, `database_access_restricted`.
edit_rows string	Can be one of: `database_access_all`, `database_access_restricted`.
add_rows string	Can be one of: `database_access_all`, `database_access_restricted`.
view_table string	Can be one of: `database_access_all`, `database_access_restricted`.
num_rows integer	Number of rows, not maintained automatically.
max_row_id integer	For setting DatabaseRow.RowID, not maintained automatically.
num_columns integer	Number of columns, automatically maintained.
max_col_id integer	For setting unique column ids.
display_template string	Display template.
columns array of Database Column objects nullable
id_default_hidden boolean	If the ID column should be hidden by default.
updated_default_hidden boolean	If the Updated column should be hidden by default.

Example Object

{
   "add_rows": "database_access_all",
   "columns": [
     {
       "id": 52691321,
       "name": "Multiple Choice: Including tribe anything from whose.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Next each secondly must catch politely.",
         "Sleepy where i.e. inquisitively yours wisp.",
         "Regularly nice cackle ourselves heavily now."
       ],
       "width": 0,
       "default_hidden": false,
       "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
     }
   ],
   "created": "2009-11-10T15:00:00-08:00",
   "desc": "",
   "desc_type": "",
   "display_template": "",
   "edit_rows": "database_access_all",
   "edit_table": "database_access_all",
   "group_id": 33,
   "id": 27,
   "id_default_hidden": false,
   "max_col_id": 14,
   "max_row_id": 63,
   "name": "",
   "num_columns": 28,
   "num_rows": 84,
   "object": "databasetable",
   "short_desc": "",
   "updated": "2009-11-10T15:00:00-08:00",
   "updated_default_hidden": false,
   "user_id": 58,
   "view_table": "database_access_all"
}

The Database Table List Object#

Database Table List

Response Attributes

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

Methods That Use This Object

Get Databases	View Method

Example Object

{
   "data": [
     {
       "add_rows": "database_access_all",
       "columns": [
         {
           "id": 52691321,
           "name": "Multiple Choice: Including tribe anything from whose.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Next each secondly must catch politely.",
             "Sleepy where i.e. inquisitively yours wisp.",
             "Regularly nice cackle ourselves heavily now."
           ],
           "width": 0,
           "default_hidden": false,
           "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
         }
       ],
       "created": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "desc_type": "",
       "display_template": "",
       "edit_rows": "database_access_all",
       "edit_table": "database_access_all",
       "group_id": 54,
       "id": 46,
       "id_default_hidden": false,
       "max_col_id": 91,
       "max_row_id": 29,
       "name": "",
       "num_columns": 16,
       "num_rows": 23,
       "object": "databasetable",
       "short_desc": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "updated_default_hidden": false,
       "user_id": 26,
       "view_table": "database_access_all"
     }
   ],
   "end_item": 33,
   "has_more": false,
   "next_page_token": 53,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 36,
   "total_count": 52
}

The Database Value Object#

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

Response Attributes

col_id integer	The column ID.
col_type string	The column type. Can be one of: `address_column`, `checkbox_column`, `date_column`, `email_column`, `github_id_column`, `html_paragraph_column`, `image_column`, `link_column`, `multi_choice_column`, `multiple_choice_column`, `number_column`, `paragraph_column`, `text_column`, `time_column`.
text optional string	For columns of type `text`.
html_text optional string	For columns of type `html_paragraph`.
date optional string date-time	For columns of type `time`.
time optional string date-time	For columns of type `date`.
checked optional boolean	For columns of type `checkbox`.
multi_choice optional array of integer	For columns of type `multi_choice` and `multiple_choice`.
street_address1 optional string	For columns of type `address`.
street_address2 optional string	For columns of type `address`.
city optional string	For columns of type `address`.
state optional string	For columns of type `address`.
zip optional string	For columns of type `address`.
country optional string	For columns of type `address`.
lat optional number	Google maps geocode latitude coordinate for `address` columns.
lng optional number	Google maps geocode longitude coordinate for `address` columns.
title optional string	For columns of type `link`.
url optional string	For columns of type `link`.
desc optional string	For columns of type `link`.
image_name optional string	For columns of type `image`.
image_data optional array of byte
number optional number	For columns of type `number`.
github_login optional string	For columns of type `github_id`.
github_name optional string
github_email optional string
github_avatar_url optional string
github_profile_url optional string
github_id optional integer
github_company optional string
github_location optional string
github_bio optional string

Example Object

{
   "checked": false,
   "city": "",
   "col_id": 36,
   "col_type": "address_column",
   "country": "",
   "date": "2009-11-10T15:00:00-08:00",
   "desc": "",
   "github_avatar_url": "",
   "github_bio": "",
   "github_company": "",
   "github_email": "",
   "github_id": 1,
   "github_location": "",
   "github_login": "",
   "github_name": "",
   "github_profile_url": "",
   "html_text": "",
   "image_data": [
     ""
   ],
   "image_name": "",
   "lat": 3.2,
   "lng": 3.2,
   "multi_choice": [
     56
   ],
   "number": 3.2,
   "state": "",
   "street_address1": "",
   "street_address2": "",
   "text": "",
   "time": "2009-11-10T15:00:00-08:00",
   "title": "",
   "url": "",
   "zip": ""
}

The Delivery Info Object#

The delivery info object.

Response Attributes

object string	delivery_info.
created string date-time
updated string date-time
group_id integer	ID of the group.
success_msg_id integer	most recent successful delivery.
success_time string date-time
success_subject string
success_type string	Can be one of: `delivery_bounce_probe`, `delivery_confirm_pending`, `delivery_confirmation`, `delivery_digest`, `delivery_direct_add`, `delivery_invite`, `delivery_login_link`, `delivery_member_notice`, `delivery_mod_notice`, `delivery_reply`, `delivery_reverify`, `delivery_single`, `delivery_summary`, `delivery_to_owner`, `delivery_to_sub`.
success_response string
attempt_msg_id integer	most recent attempted delivery.
attempt_time string date-time
attempt_subject string
attempt_type string	Can be one of: `delivery_bounce_probe`, `delivery_confirm_pending`, `delivery_confirmation`, `delivery_digest`, `delivery_direct_add`, `delivery_invite`, `delivery_login_link`, `delivery_member_notice`, `delivery_mod_notice`, `delivery_reply`, `delivery_reverify`, `delivery_single`, `delivery_summary`, `delivery_to_owner`, `delivery_to_sub`.
attempt_response string
bounces array of Bounce Info objects nullable	Bounces.

Methods That Use This Object

Get Delivery Info	View Method

Example Object

{
   "attempt_msg_id": 51,
   "attempt_response": "",
   "attempt_subject": "",
   "attempt_time": "2009-11-10T15:00:00-08:00",
   "attempt_type": "delivery_bounce_probe",
   "bounces": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 39,
       "is_hard": false,
       "msg_id": 54,
       "object": "bounce_info",
       "response": "",
       "subject": "",
       "type": "delivery_bounce_probe"
     }
   ],
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 7,
   "object": "delivery_info",
   "success_msg_id": 56,
   "success_response": "",
   "success_subject": "",
   "success_time": "2009-11-10T15:00:00-08:00",
   "success_type": "delivery_bounce_probe",
   "updated": "2009-11-10T15:00:00-08:00"
}

The Direct Add Error Object#

The direct add error object.

Response Attributes

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

Example Object

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

The Direct Add Results Object#

The direct add results object.

Response Attributes

object string	direct_add_results.
total_emails integer
errors array of Direct Add Error objects nullable
added_members array of Member Info objects nullable

Methods That Use This Object

Direct Add	View Method
Send Invites	View Method

Example Object

{
   "added_members": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "errors": [
     {
       "alias_of": "",
       "email": "",
       "group_id": 30,
       "object": "direct_add_error",
       "status": ""
     }
   ],
   "object": "direct_add_results",
   "total_emails": 28
}

The Draft Object#

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

Response Attributes

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

Methods That Use This Object

New Draft	View Method
Update Draft	View Method

Example Object

{
   "bcc_all": false,
   "bcc_me": false,
   "body": "",
   "body_type": "",
   "created": "2009-11-10T15:00:00-08:00",
   "draft_type": "",
   "group_id": 16,
   "id": 60,
   "is_special": false,
   "message_id": 74,
   "next_attachment_id": 18,
   "num_attachments": 73,
   "object": "draft",
   "subject": "",
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 5
}

The Draft Attachment Object#

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

Response Attributes

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

Example Object

{
   "content_type": "",
   "draft_id": 66,
   "filename": "",
   "id": 24,
   "inline": false,
   "object": "draft_attachment",
   "size": 98,
   "url": ""
}

The Draft Attachment List Object#

Draft Attachment List

Response Attributes

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

Methods That Use This Object

Upload Attachments	View Method
Get Attachments	View Method

Example Object

{
   "data": [
     {
       "content_type": "",
       "draft_id": 97,
       "filename": "",
       "id": 72,
       "inline": false,
       "object": "draft_attachment",
       "size": 75,
       "url": ""
     }
   ],
   "end_item": 74,
   "has_more": false,
   "next_page_token": 12,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 70,
   "total_count": 1
}

The Draft List Object#

Draft List

Response Attributes

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

Methods That Use This Object

Get Drafts	View Method

Example Object

{
   "data": [
     {
       "bcc_all": false,
       "bcc_me": false,
       "body": "",
       "body_type": "",
       "created": "2009-11-10T15:00:00-08:00",
       "draft_type": "",
       "group_id": 70,
       "id": 40,
       "is_special": false,
       "message_id": 84,
       "next_attachment_id": 99,
       "num_attachments": 63,
       "object": "draft",
       "subject": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 60
     }
   ],
   "end_item": 25,
   "has_more": false,
   "next_page_token": 80,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 95,
   "total_count": 30
}

The Enterprise Info Object#

The enterprise object.

Response Attributes

object string	enterprise_info.
domain string
logo array of byte nullable

Example Object

{
   "domain": "",
   "logo": [
     ""
   ],
   "object": "enterprise_info"
}

The Error Object#

The error object.

Response Attributes

object string	error.
type string
extra string

Example Object

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

The Event Object#

The event object.

Response Attributes

id integer	Unique ID of the rsvp object.
object string	event.
created string date-time	The time that this object was created.
updated string date-time	The time that this object was last updated.
creator_name string	Name of the person who created this event.
group_id integer	The ID of the associated group.
group_name string	Name of the associated group.
nice_group_name string	Nice version of the group name.
start_time string date-time	Start time of event.
end_time string date-time	End time of event.
timezone string	Timezone that event was created in.
all_day boolean	If event is all day.
name string	Name of the event.
location string	Location of the event.
description string	Event description, in HTML format.
organizer_name string	Organizer name.
organizer_email string	Organizer email.
organizer_phone string	Organizer phone number.
color_name string	Name of the event color. Can be one of: `color_antique_pink`, `color_apricot`, `color_aquamute`, `color_beige`, `color_bluejean`, `color_blush`, `color_burnt_yellow`, `color_capri_blue`, `color_cerulean_blue`, `color_cherry_blossom`, `color_cloudy_blue`, `color_cucumber`, `color_dark_grey`, `color_dark_orange`, `color_dusty_mauve`, `color_emerald_green`, `color_grape`, `color_green_lantern`, `color_green_sage`, `color_grey_blue`, `color_light_brown`, `color_light_grey`, `color_light_lilac`, `color_lilac`, `color_lips`, `color_melon`, `color_military`, `color_moss_green`, `color_mulbery`, `color_mustard`, `color_none`, `color_orange`, `color_orchid`, `color_peony`, `color_pink`, `color_purple`, `color_purple_blue`, `color_purple_grey`, `color_sage`, `color_sky`, `color_terracotta`, `color_tomato`, `color_yellow`.
color_hex string	Hex value of the event color.
rsvp boolean	Requesting an RSVP.
max_attendees integer	Number of attendees for RSVP events (0 if unlimited).
additional_guests boolean	Whether attendees can bring additional people.
comment_label string	If additional information is requested, this is the label for that field.
show_comments boolean	Whether RSVP comments are visible to all members, not just those who can edit the event.
yes_message string	Email to send when people RSVP Yes, in same format as Format.
has_rsvp boolean	If there is an RSVP record for this event corresponding to this user.
rsvp_type string	Type of RSVP.
rsvp_comment string	Any comment left with the RSVP.
rsvp_additional_guests integer	Number of additional guests specified by the RSVP.

Methods That Use This Object

Get Event	View Method
Add Event	View Method
Add Repeat Event	View Method
Split Repeat Event	View Method

Example Object

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

The Event List Object#

The Event List object contains a list of Event objects.

Response Attributes

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

Methods That Use This Object

Get Events	View Method

Example Object

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

The Feed Object#

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

Response Attributes

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

Methods That Use This Object

Get Single Feed	View Method

Example Object

{
   "chats": [
     {
       "id": 52691321,
       "object": "chat",
       "created": "2020-09-15T02:30:00-07:00",
       "updated": "2021-03-01T18:07:00-08:00",
       "user_id": 147779411,
       "profile_photo_url": "",
       "name": "",
       "can_view_profile": false,
       "group_id": 8658933,
       "subject": "Including.",
       "desc": "Tribe anything from.",
       "is_closed": false,
       "num_messages": 21,
       "chat_sub": {
         "id": 179889653,
         "object": "chat_sub",
         "created": "2020-09-10T11:42:00-07:00",
         "updated": "2023-03-29T23:48:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "chat_id": 52691321,
         "last_msg_seen": 40
       }
     }
   ],
   "events": [
     {
       "additional_guests": false,
       "all_day": false,
       "color_hex": "",
       "color_name": "color_antique_pink",
       "comment_label": "",
       "created": "2009-11-10T15:00:00-08:00",
       "creator_name": "@JohnSmith",
       "description": "",
       "end_time": "2009-11-10T15:00:00-08:00",
       "group_id": 32,
       "group_name": "",
       "has_rsvp": false,
       "id": 40,
       "location": "",
       "max_attendees": 86,
       "name": "",
       "nice_group_name": "",
       "object": "event",
       "organizer_email": "",
       "organizer_name": "",
       "organizer_phone": "",
       "rsvp": false,
       "rsvp_additional_guests": 55,
       "rsvp_comment": "",
       "rsvp_type": "",
       "show_comments": false,
       "start_time": "2009-11-10T15:00:00-08:00",
       "timezone": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "yes_message": ""
     }
   ],
   "files": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-15T02:30:00-07:00",
       "updated": "2021-03-01T18:07:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ],
   "group": {
     "id": 8658933,
     "object": "group",
     "created": "2020-09-15T11:29:00-07:00",
     "updated": "2022-02-12T18:51:00-08:00",
     "type": "group_type_messages",
     "title": "",
     "name": "StrategyHub",
     "nice_group_name": "",
     "alias": "",
     "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
     "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
     "subject_tag": "[StrategyHub]",
     "footer": "This is my\nFooter!!!!",
     "website": "",
     "announce": false,
     "moderation": "moderated",
     "new_users_moderated": true,
     "unmoderate_users_after": 3,
     "restricted": true,
     "invite_only": false,
     "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_by_members",
     "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,
     "two_factor_policy": "group_2fa_policy_none",
     "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,
     "ai_summaries_enabled": false,
     "sticky_wiki_page_id": 0,
     "sub_group_categoryid": 0,
     "subs_count": 541,
     "pending_subs_count": 0,
     "pending_msgs_count": 0,
     "open_chats_count": 0,
     "threads_count": 0,
     "messages_count": 0,
     "org_domain": "",
     "most_recent_message": "2020-09-07T19:38:00-07: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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "email_address": "StrategyHub@groups.io",
     "extra_member_data_columns": [
       {
         "id": 48876437,
         "name": "Text: Lots write point week doctor.",
         "type": "text_column",
         "required": true,
         "color": "color_beige",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Movement whose also it vanish watch these to ever always."
       },
       {
         "id": 161476183,
         "name": "Paragraph: Other few covey range window.",
         "type": "paragraph_column",
         "required": true,
         "color": "color_light_brown",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Silence lastly had what outcome let while school pause up."
       },
       {
         "id": 39354277,
         "name": "Checkbox: Company freedom pout his throw.",
         "type": "checkbox_column",
         "required": true,
         "color": "color_orange",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Quarterly outfit faithful is often part whom these been hourly."
       },
       {
         "id": 8897324,
         "name": "Multiple Choice: Madagascan anyway should late yours.",
         "type": "multiple_choice_column",
         "required": true,
         "color": "color_orchid",
         "choices": [
           "Monthly ball upon almost everything dynasty.",
           "Behalf shall nearly this weekly for.",
           "Anywhere everybody over secondly then boat."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Besides pack when murder her had snore first in limp."
       },
       {
         "id": 159828550,
         "name": "Date: Which these bale nobody few.",
         "type": "date_column",
         "required": true,
         "color": "color_blush",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "How anyone these string life that who result lately yourselves."
       },
       {
         "id": 185149472,
         "name": "Time: Besides later whom for rarely.",
         "type": "time_column",
         "required": true,
         "color": "color_sage",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Each her ski ours host our as did they to."
       },
       {
         "id": 166814414,
         "name": "Address: Bravery where this as cloud.",
         "type": "address_column",
         "required": true,
         "color": "color_cucumber",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Inside since open most you that including fight murder cautiously."
       },
       {
         "id": 102385421,
         "name": "Multi Choice: Another what full her can.",
         "type": "multi_choice_column",
         "required": true,
         "color": "color_aquamute",
         "choices": [
           "Indeed besides motherhood in that nightly.",
           "Limit we kneel herself collect yourselves.",
           "Yourselves Norwegian this fear happily fruit."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Pout nature bike moreover from whoever afterwards myself mine to."
       },
       {
         "id": 154317202,
         "name": "Link: Bale sedge Christian would whose.",
         "type": "link_column",
         "required": true,
         "color": "color_military",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Hers pack rhythm that now whose her out infancy somebody."
       },
       {
         "id": 123191768,
         "name": "Image: Today scenic consequently ours eye.",
         "type": "image_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Other other abundant some anywhere this life nevertheless in next."
       },
       {
         "id": 53386358,
         "name": "HTML Paragraph: Nobody what today e.g. loss.",
         "type": "html_paragraph_column",
         "required": true,
         "color": "color_emerald_green",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Spite Philippine before throughout wander of as there next of."
       },
       {
         "id": 45812071,
         "name": "Email: That because am terribly many.",
         "type": "email_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Because anyone does you hungrily can several might who monthly."
       }
     ]
   },
   "hashtags": [
     {
       "id": 541,
       "object": "hashtag",
       "created": "2020-09-17T11:22:00-07:00",
       "group_id": 1188,
       "name": "Karl",
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": true,
       "replies_unmoderated": false,
       "locked": true,
       "until": "hashtag_delete_month",
       "close_instead_of_delete": true,
       "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
       "color_name": "pink",
       "color_hex": "#f39de4",
       "reply_to": "thread_reply_to_sender",
       "topic_count": 1789,
       "last_message_date": "2020-09-08T01:22:00-07:00",
       "muted": null,
       "followed": null
     }
   ],
   "member_info": {
     "id": 93846546,
     "object": "member_info",
     "created": "2020-09-09T04:11:00-07:00",
     "updated": "2022-06-08T07:16:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "group_name": "StrategyHub",
     "status": "sub_status_normal",
     "post_status": "sub_poststatus_newusermoderated",
     "email_delivery": "email_delivery_digest",
     "message_selection": "message_selection_follow_and_first_message",
     "auto_follow_replies": false,
     "max_attachment_size": "max_attachment_size_medium",
     "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "profile_privacy": "profile_private",
     "dont_munge_message_id": false,
     "use_signature": false,
     "use_signature_email": false,
     "signature": "In hotel furniture anyone weakly besides",
     "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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "member_labels": [
       {
         "id": 726,
         "object": "memberlabel",
         "created": "2020-09-29T22:19:00Z",
         "group_id": 1857,
         "name": "Florida",
         "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
         "color_name": "green-sage",
         "color_hex": "#9fc4ac"
       },
       {
         "id": 1594,
         "object": "memberlabel",
         "created": "2020-09-24T02:24:00Z",
         "group_id": 42,
         "name": "Russel",
         "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
         "color_name": "purple",
         "color_hex": "#837fd5"
       },
       {
         "id": 1189,
         "object": "memberlabel",
         "created": "2020-09-12T02:11:00Z",
         "group_id": 1474,
         "name": "Meta",
         "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
         "color_name": "sky",
         "color_hex": "#9cc7df"
       }
     ],
     "extra_member_data": [
       {
         "col_id": 48876437,
         "col_type": "text_column",
         "text": "To firstly unlock while host himself me purely as whose."
       },
       {
         "col_id": 161476183,
         "col_type": "paragraph_column",
         "text": "Yet few mustering example will addition yearly since in these."
       },
       {
         "col_id": 39354277,
         "col_type": "checkbox_column",
         "checked": false
       },
       {
         "col_id": 8897324,
         "col_type": "multiple_choice_column",
         "multi_choice": [
           0
         ]
       },
       {
         "col_id": 159828550,
         "col_type": "date_column",
         "date": "1923-10-16T17:57:55.797000001Z"
       },
       {
         "col_id": 185149472,
         "col_type": "time_column",
         "time": "1929-03-30T18:00:36.790929649Z"
       },
       {
         "col_id": 166814414,
         "col_type": "address_column",
         "street_address1": "Premier Medical Group",
         "street_address2": "3701 DAUPHIN ST",
         "city": "MOBILE",
         "state": "AL",
         "zip": "36608-1756",
         "lat": 30.6866076,
         "lng": -88.13019249999999
       },
       {
         "col_id": 102385421,
         "col_type": "multi_choice_column",
         "multi_choice": [
           0,
           1,
           2
         ]
       },
       {
         "col_id": 154317202,
         "col_type": "link_column",
         "title": "To say poorly out according abundant unless nervously string lastly.",
         "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
         "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
       },
       {
         "col_id": 123191768,
         "col_type": "image_column",
         "url": "https://picsum.photos/id/27/187/110",
         "image_name": "Lately blazer with wild hourly there she it infrequently power."
       },
       {
         "col_id": 53386358,
         "col_type": "html_paragraph_column",
         "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
       },
       {
         "col_id": 45812071,
         "col_type": "email_column",
         "text": "brantkozey@bernhard.com"
       }
     ]
   },
   "object": "feed",
   "photos": [
     {
       "id": 960,
       "object": "photo",
       "created": "2020-09-06T23:48:00-07:00",
       "updated": "2022-03-08T08:06:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Elegance joy group",
       "desc": "Senegalese whichever happen trade move outside downstairs of exemplified up. Out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for. Her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look.",
       "media_type": "image/jpg",
       "size": 2390440,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 52691321,
       "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": ""
     }
   ],
   "subgroups": [
     {
       "id": 8658933,
       "object": "group",
       "created": "2020-09-15T11:29:00-07:00",
       "updated": "2022-02-12T18:51:00-08:00",
       "type": "group_type_messages",
       "title": "",
       "name": "StrategyHub",
       "nice_group_name": "",
       "alias": "",
       "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
       "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
       "subject_tag": "[StrategyHub]",
       "footer": "This is my\nFooter!!!!",
       "website": "",
       "announce": false,
       "moderation": "moderated",
       "new_users_moderated": true,
       "unmoderate_users_after": 3,
       "restricted": true,
       "invite_only": false,
       "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_by_members",
       "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,
       "two_factor_policy": "group_2fa_policy_none",
       "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,
       "ai_summaries_enabled": false,
       "sticky_wiki_page_id": 0,
       "sub_group_categoryid": 0,
       "subs_count": 541,
       "pending_subs_count": 0,
       "pending_msgs_count": 0,
       "open_chats_count": 0,
       "threads_count": 0,
       "messages_count": 0,
       "org_domain": "",
       "most_recent_message": "2020-09-07T19:38:00-07: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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "email_address": "StrategyHub@groups.io",
       "extra_member_data_columns": [
         {
           "id": 48876437,
           "name": "Text: Lots write point week doctor.",
           "type": "text_column",
           "required": true,
           "color": "color_beige",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Movement whose also it vanish watch these to ever always."
         },
         {
           "id": 161476183,
           "name": "Paragraph: Other few covey range window.",
           "type": "paragraph_column",
           "required": true,
           "color": "color_light_brown",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Silence lastly had what outcome let while school pause up."
         },
         {
           "id": 39354277,
           "name": "Checkbox: Company freedom pout his throw.",
           "type": "checkbox_column",
           "required": true,
           "color": "color_orange",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Quarterly outfit faithful is often part whom these been hourly."
         },
         {
           "id": 8897324,
           "name": "Multiple Choice: Madagascan anyway should late yours.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Monthly ball upon almost everything dynasty.",
             "Behalf shall nearly this weekly for.",
             "Anywhere everybody over secondly then boat."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Besides pack when murder her had snore first in limp."
         },
         {
           "id": 159828550,
           "name": "Date: Which these bale nobody few.",
           "type": "date_column",
           "required": true,
           "color": "color_blush",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "How anyone these string life that who result lately yourselves."
         },
         {
           "id": 185149472,
           "name": "Time: Besides later whom for rarely.",
           "type": "time_column",
           "required": true,
           "color": "color_sage",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Each her ski ours host our as did they to."
         },
         {
           "id": 166814414,
           "name": "Address: Bravery where this as cloud.",
           "type": "address_column",
           "required": true,
           "color": "color_cucumber",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Inside since open most you that including fight murder cautiously."
         },
         {
           "id": 102385421,
           "name": "Multi Choice: Another what full her can.",
           "type": "multi_choice_column",
           "required": true,
           "color": "color_aquamute",
           "choices": [
             "Indeed besides motherhood in that nightly.",
             "Limit we kneel herself collect yourselves.",
             "Yourselves Norwegian this fear happily fruit."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Pout nature bike moreover from whoever afterwards myself mine to."
         },
         {
           "id": 154317202,
           "name": "Link: Bale sedge Christian would whose.",
           "type": "link_column",
           "required": true,
           "color": "color_military",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Hers pack rhythm that now whose her out infancy somebody."
         },
         {
           "id": 123191768,
           "name": "Image: Today scenic consequently ours eye.",
           "type": "image_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Other other abundant some anywhere this life nevertheless in next."
         },
         {
           "id": 53386358,
           "name": "HTML Paragraph: Nobody what today e.g. loss.",
           "type": "html_paragraph_column",
           "required": true,
           "color": "color_emerald_green",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Spite Philippine before throughout wander of as there next of."
         },
         {
           "id": 45812071,
           "name": "Email: That because am terribly many.",
           "type": "email_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Because anyone does you hungrily can several might who monthly."
         }
       ]
     }
   ],
   "tables": [
     {
       "add_rows": "database_access_all",
       "columns": [
         {
           "id": 52691321,
           "name": "Multiple Choice: Including tribe anything from whose.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Next each secondly must catch politely.",
             "Sleepy where i.e. inquisitively yours wisp.",
             "Regularly nice cackle ourselves heavily now."
           ],
           "width": 0,
           "default_hidden": false,
           "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
         }
       ],
       "created": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "desc_type": "",
       "display_template": "",
       "edit_rows": "database_access_all",
       "edit_table": "database_access_all",
       "group_id": 94,
       "id": 0,
       "id_default_hidden": false,
       "max_col_id": 40,
       "max_row_id": 79,
       "name": "",
       "num_columns": 76,
       "num_rows": 58,
       "object": "databasetable",
       "short_desc": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "updated_default_hidden": false,
       "user_id": 57,
       "view_table": "database_access_all"
     }
   ],
   "topics": [
     {
       "images": [
         {
           "attach_num": 76,
           "content": "",
           "created": "2009-11-10T15:00:00-08:00",
           "group_id": 19,
           "id": "",
           "image_height": 86,
           "image_width": 63,
           "message_num": 12,
           "name": "",
           "object": "attachment",
           "sub_type": "",
           "thread_id": 98,
           "thumbnail_url": "",
           "type": "",
           "user_id": 2
         }
       ],
       "topic": {
         "id": 52691321,
         "object": "topic",
         "created": "2020-09-15T02:30:00-07:00",
         "updated": "2021-03-01T18:07:00-08:00",
         "group_id": 8658933,
         "group_subject_tag": "[StrategyHub]",
         "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
         "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
         "name": "Elenor Schaefer",
         "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": "2020-09-29T17:03:00-07:00",
         "hashtags": null
       }
     }
   ],
   "wikis": [
     {
       "id": 52691321,
       "object": "wiki_page",
       "created": "2020-09-15T02:30:00-07:00",
       "updated": "2021-03-01T18:07:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "Including tribe anything from whose market",
       "path": "Including-tribe-anything-from-whose-market",
       "locked": false,
       "rev_count": 43
     }
   ]
}

The Feed List Object#

The Feed List object contains a list of Feed objects.

Response Attributes

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

Methods That Use This Object

Get Feed	View Method

Example Object

{
   "data": [
     {
       "chats": [
         {
           "id": 52691321,
           "object": "chat",
           "created": "2020-09-15T02:30:00-07:00",
           "updated": "2021-03-01T18:07:00-08:00",
           "user_id": 147779411,
           "profile_photo_url": "",
           "name": "",
           "can_view_profile": false,
           "group_id": 8658933,
           "subject": "Including.",
           "desc": "Tribe anything from.",
           "is_closed": false,
           "num_messages": 21,
           "chat_sub": {
             "id": 179889653,
             "object": "chat_sub",
             "created": "2020-09-10T11:42:00-07:00",
             "updated": "2023-03-29T23:48:00-07:00",
             "user_id": 147779411,
             "group_id": 8658933,
             "chat_id": 52691321,
             "last_msg_seen": 40
           }
         }
       ],
       "events": [
         {
           "additional_guests": false,
           "all_day": false,
           "color_hex": "",
           "color_name": "color_antique_pink",
           "comment_label": "",
           "created": "2009-11-10T15:00:00-08:00",
           "creator_name": "@JohnSmith",
           "description": "",
           "end_time": "2009-11-10T15:00:00-08:00",
           "group_id": 54,
           "group_name": "",
           "has_rsvp": false,
           "id": 41,
           "location": "",
           "max_attendees": 91,
           "name": "",
           "nice_group_name": "",
           "object": "event",
           "organizer_email": "",
           "organizer_name": "",
           "organizer_phone": "",
           "rsvp": false,
           "rsvp_additional_guests": 29,
           "rsvp_comment": "",
           "rsvp_type": "",
           "show_comments": false,
           "start_time": "2009-11-10T15:00:00-08:00",
           "timezone": "",
           "updated": "2009-11-10T15:00:00-08:00",
           "yes_message": ""
         }
       ],
       "files": [
         {
           "id": 52691321,
           "object": "file",
           "created": "2020-09-15T02:30:00-07:00",
           "updated": "2021-03-01T18:07:00-08:00",
           "user_id": 147779411,
           "group_id": 8658933,
           "name": "Kelsi Ledner",
           "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
           "size": 132787700,
           "path": "topfolder/subfolder",
           "parent_folder_id": 0,
           "type": "file_type_file",
           "count": 2,
           "media_type": "text/plain",
           "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
           "display_name": "Lawson Kreiger",
           "user_name": "Dickens6041",
           "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
           "profile_privacy": "profile_private",
           "email": "gersonbeahan@..."
         }
       ],
       "group": {
         "id": 8658933,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "StrategyHub",
         "nice_group_name": "",
         "alias": "",
         "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
         "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
         "subject_tag": "[StrategyHub]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "invite_only": false,
         "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_by_members",
         "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,
         "two_factor_policy": "group_2fa_policy_none",
         "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,
         "ai_summaries_enabled": false,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 541,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "2020-09-07T19:38:00-07: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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "email_address": "StrategyHub@groups.io",
         "extra_member_data_columns": [
           {
             "id": 48876437,
             "name": "Text: Lots write point week doctor.",
             "type": "text_column",
             "required": true,
             "color": "color_beige",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Movement whose also it vanish watch these to ever always."
           },
           {
             "id": 161476183,
             "name": "Paragraph: Other few covey range window.",
             "type": "paragraph_column",
             "required": true,
             "color": "color_light_brown",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Silence lastly had what outcome let while school pause up."
           },
           {
             "id": 39354277,
             "name": "Checkbox: Company freedom pout his throw.",
             "type": "checkbox_column",
             "required": true,
             "color": "color_orange",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Quarterly outfit faithful is often part whom these been hourly."
           },
           {
             "id": 8897324,
             "name": "Multiple Choice: Madagascan anyway should late yours.",
             "type": "multiple_choice_column",
             "required": true,
             "color": "color_orchid",
             "choices": [
               "Monthly ball upon almost everything dynasty.",
               "Behalf shall nearly this weekly for.",
               "Anywhere everybody over secondly then boat."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Besides pack when murder her had snore first in limp."
           },
           {
             "id": 159828550,
             "name": "Date: Which these bale nobody few.",
             "type": "date_column",
             "required": true,
             "color": "color_blush",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "How anyone these string life that who result lately yourselves."
           },
           {
             "id": 185149472,
             "name": "Time: Besides later whom for rarely.",
             "type": "time_column",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Each her ski ours host our as did they to."
           },
           {
             "id": 166814414,
             "name": "Address: Bravery where this as cloud.",
             "type": "address_column",
             "required": true,
             "color": "color_cucumber",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Inside since open most you that including fight murder cautiously."
           },
           {
             "id": 102385421,
             "name": "Multi Choice: Another what full her can.",
             "type": "multi_choice_column",
             "required": true,
             "color": "color_aquamute",
             "choices": [
               "Indeed besides motherhood in that nightly.",
               "Limit we kneel herself collect yourselves.",
               "Yourselves Norwegian this fear happily fruit."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pout nature bike moreover from whoever afterwards myself mine to."
           },
           {
             "id": 154317202,
             "name": "Link: Bale sedge Christian would whose.",
             "type": "link_column",
             "required": true,
             "color": "color_military",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Hers pack rhythm that now whose her out infancy somebody."
           },
           {
             "id": 123191768,
             "name": "Image: Today scenic consequently ours eye.",
             "type": "image_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Other other abundant some anywhere this life nevertheless in next."
           },
           {
             "id": 53386358,
             "name": "HTML Paragraph: Nobody what today e.g. loss.",
             "type": "html_paragraph_column",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Spite Philippine before throughout wander of as there next of."
           },
           {
             "id": 45812071,
             "name": "Email: That because am terribly many.",
             "type": "email_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Because anyone does you hungrily can several might who monthly."
           }
         ]
       },
       "hashtags": [
         {
           "id": 541,
           "object": "hashtag",
           "created": "2020-09-17T11:22:00-07:00",
           "group_id": 1188,
           "name": "Karl",
           "mods_only_post": false,
           "mods_only_replies": false,
           "no_email": false,
           "moderated": false,
           "special": true,
           "replies_unmoderated": false,
           "locked": true,
           "until": "hashtag_delete_month",
           "close_instead_of_delete": true,
           "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
           "color_name": "pink",
           "color_hex": "#f39de4",
           "reply_to": "thread_reply_to_sender",
           "topic_count": 1789,
           "last_message_date": "2020-09-08T01:22:00-07:00",
           "muted": null,
           "followed": null
         }
       ],
       "member_info": {
         "id": 93846546,
         "object": "member_info",
         "created": "2020-09-09T04:11:00-07:00",
         "updated": "2022-06-08T07:16:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "group_name": "StrategyHub",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_digest",
         "message_selection": "message_selection_follow_and_first_message",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_medium",
         "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "In hotel furniture anyone weakly besides",
         "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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "member_labels": [
           {
             "id": 726,
             "object": "memberlabel",
             "created": "2020-09-29T22:19:00Z",
             "group_id": 1857,
             "name": "Florida",
             "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
             "color_name": "green-sage",
             "color_hex": "#9fc4ac"
           },
           {
             "id": 1594,
             "object": "memberlabel",
             "created": "2020-09-24T02:24:00Z",
             "group_id": 42,
             "name": "Russel",
             "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
             "color_name": "purple",
             "color_hex": "#837fd5"
           },
           {
             "id": 1189,
             "object": "memberlabel",
             "created": "2020-09-12T02:11:00Z",
             "group_id": 1474,
             "name": "Meta",
             "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
             "color_name": "sky",
             "color_hex": "#9cc7df"
           }
         ],
         "extra_member_data": [
           {
             "col_id": 48876437,
             "col_type": "text_column",
             "text": "To firstly unlock while host himself me purely as whose."
           },
           {
             "col_id": 161476183,
             "col_type": "paragraph_column",
             "text": "Yet few mustering example will addition yearly since in these."
           },
           {
             "col_id": 39354277,
             "col_type": "checkbox_column",
             "checked": false
           },
           {
             "col_id": 8897324,
             "col_type": "multiple_choice_column",
             "multi_choice": [
               0
             ]
           },
           {
             "col_id": 159828550,
             "col_type": "date_column",
             "date": "1923-10-16T17:57:55.797000001Z"
           },
           {
             "col_id": 185149472,
             "col_type": "time_column",
             "time": "1929-03-30T18:00:36.790929649Z"
           },
           {
             "col_id": 166814414,
             "col_type": "address_column",
             "street_address1": "Premier Medical Group",
             "street_address2": "3701 DAUPHIN ST",
             "city": "MOBILE",
             "state": "AL",
             "zip": "36608-1756",
             "lat": 30.6866076,
             "lng": -88.13019249999999
           },
           {
             "col_id": 102385421,
             "col_type": "multi_choice_column",
             "multi_choice": [
               0,
               1,
               2
             ]
           },
           {
             "col_id": 154317202,
             "col_type": "link_column",
             "title": "To say poorly out according abundant unless nervously string lastly.",
             "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
             "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
           },
           {
             "col_id": 123191768,
             "col_type": "image_column",
             "url": "https://picsum.photos/id/27/187/110",
             "image_name": "Lately blazer with wild hourly there she it infrequently power."
           },
           {
             "col_id": 53386358,
             "col_type": "html_paragraph_column",
             "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
           },
           {
             "col_id": 45812071,
             "col_type": "email_column",
             "text": "brantkozey@bernhard.com"
           }
         ]
       },
       "object": "feed",
       "photos": [
         {
           "id": 960,
           "object": "photo",
           "created": "2020-09-06T23:48:00-07:00",
           "updated": "2022-03-08T08:06:00-08:00",
           "user_id": 147779411,
           "group_id": 8658933,
           "name": "Elegance joy group",
           "desc": "Senegalese whichever happen trade move outside downstairs of exemplified up. Out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for. Her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look.",
           "media_type": "image/jpg",
           "size": 2390440,
           "attachment_num": 0,
           "width": 0,
           "height": 0,
           "album_id": 52691321,
           "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": ""
         }
       ],
       "subgroups": [
         {
           "id": 8658933,
           "object": "group",
           "created": "2020-09-15T11:29:00-07:00",
           "updated": "2022-02-12T18:51:00-08:00",
           "type": "group_type_messages",
           "title": "",
           "name": "StrategyHub",
           "nice_group_name": "",
           "alias": "",
           "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
           "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
           "subject_tag": "[StrategyHub]",
           "footer": "This is my\nFooter!!!!",
           "website": "",
           "announce": false,
           "moderation": "moderated",
           "new_users_moderated": true,
           "unmoderate_users_after": 3,
           "restricted": true,
           "invite_only": false,
           "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_by_members",
           "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,
           "two_factor_policy": "group_2fa_policy_none",
           "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,
           "ai_summaries_enabled": false,
           "sticky_wiki_page_id": 0,
           "sub_group_categoryid": 0,
           "subs_count": 541,
           "pending_subs_count": 0,
           "pending_msgs_count": 0,
           "open_chats_count": 0,
           "threads_count": 0,
           "messages_count": 0,
           "org_domain": "",
           "most_recent_message": "2020-09-07T19:38:00-07: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,
             "ask_visible": 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_reply": 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,
             "can_ask": true
           },
           "email_address": "StrategyHub@groups.io",
           "extra_member_data_columns": [
             {
               "id": 48876437,
               "name": "Text: Lots write point week doctor.",
               "type": "text_column",
               "required": true,
               "color": "color_beige",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Movement whose also it vanish watch these to ever always."
             },
             {
               "id": 161476183,
               "name": "Paragraph: Other few covey range window.",
               "type": "paragraph_column",
               "required": true,
               "color": "color_light_brown",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Silence lastly had what outcome let while school pause up."
             },
             {
               "id": 39354277,
               "name": "Checkbox: Company freedom pout his throw.",
               "type": "checkbox_column",
               "required": true,
               "color": "color_orange",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Quarterly outfit faithful is often part whom these been hourly."
             },
             {
               "id": 8897324,
               "name": "Multiple Choice: Madagascan anyway should late yours.",
               "type": "multiple_choice_column",
               "required": true,
               "color": "color_orchid",
               "choices": [
                 "Monthly ball upon almost everything dynasty.",
                 "Behalf shall nearly this weekly for.",
                 "Anywhere everybody over secondly then boat."
               ],
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Besides pack when murder her had snore first in limp."
             },
             {
               "id": 159828550,
               "name": "Date: Which these bale nobody few.",
               "type": "date_column",
               "required": true,
               "color": "color_blush",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "How anyone these string life that who result lately yourselves."
             },
             {
               "id": 185149472,
               "name": "Time: Besides later whom for rarely.",
               "type": "time_column",
               "required": true,
               "color": "color_sage",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Each her ski ours host our as did they to."
             },
             {
               "id": 166814414,
               "name": "Address: Bravery where this as cloud.",
               "type": "address_column",
               "required": true,
               "color": "color_cucumber",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Inside since open most you that including fight murder cautiously."
             },
             {
               "id": 102385421,
               "name": "Multi Choice: Another what full her can.",
               "type": "multi_choice_column",
               "required": true,
               "color": "color_aquamute",
               "choices": [
                 "Indeed besides motherhood in that nightly.",
                 "Limit we kneel herself collect yourselves.",
                 "Yourselves Norwegian this fear happily fruit."
               ],
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Pout nature bike moreover from whoever afterwards myself mine to."
             },
             {
               "id": 154317202,
               "name": "Link: Bale sedge Christian would whose.",
               "type": "link_column",
               "required": true,
               "color": "color_military",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Hers pack rhythm that now whose her out infancy somebody."
             },
             {
               "id": 123191768,
               "name": "Image: Today scenic consequently ours eye.",
               "type": "image_column",
               "required": true,
               "color": "color_light_grey",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Other other abundant some anywhere this life nevertheless in next."
             },
             {
               "id": 53386358,
               "name": "HTML Paragraph: Nobody what today e.g. loss.",
               "type": "html_paragraph_column",
               "required": true,
               "color": "color_emerald_green",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Spite Philippine before throughout wander of as there next of."
             },
             {
               "id": 45812071,
               "name": "Email: That because am terribly many.",
               "type": "email_column",
               "required": true,
               "color": "color_light_grey",
               "width": 0,
               "default_hidden": false,
               "profile": false,
               "description": "Because anyone does you hungrily can several might who monthly."
             }
           ]
         }
       ],
       "tables": [
         {
           "add_rows": "database_access_all",
           "columns": [
             {
               "id": 52691321,
               "name": "Multiple Choice: Including tribe anything from whose.",
               "type": "multiple_choice_column",
               "required": true,
               "color": "color_orchid",
               "choices": [
                 "Next each secondly must catch politely.",
                 "Sleepy where i.e. inquisitively yours wisp.",
                 "Regularly nice cackle ourselves heavily now."
               ],
               "width": 0,
               "default_hidden": false,
               "description": "Market pyramid accordingly onto moreover whenever e.g. fear usually body."
             }
           ],
           "created": "2009-11-10T15:00:00-08:00",
           "desc": "",
           "desc_type": "",
           "display_template": "",
           "edit_rows": "database_access_all",
           "edit_table": "database_access_all",
           "group_id": 2,
           "id": 19,
           "id_default_hidden": false,
           "max_col_id": 90,
           "max_row_id": 14,
           "name": "",
           "num_columns": 5,
           "num_rows": 14,
           "object": "databasetable",
           "short_desc": "",
           "updated": "2009-11-10T15:00:00-08:00",
           "updated_default_hidden": false,
           "user_id": 24,
           "view_table": "database_access_all"
         }
       ],
       "topics": [
         {
           "images": [
             {
               "attach_num": 7,
               "content": "",
               "created": "2009-11-10T15:00:00-08:00",
               "group_id": 40,
               "id": "",
               "image_height": 70,
               "image_width": 57,
               "message_num": 46,
               "name": "",
               "object": "attachment",
               "sub_type": "",
               "thread_id": 73,
               "thumbnail_url": "",
               "type": "",
               "user_id": 28
             }
           ],
           "topic": {
             "id": 52691321,
             "object": "topic",
             "created": "2020-09-15T02:30:00-07:00",
             "updated": "2021-03-01T18:07:00-08:00",
             "group_id": 8658933,
             "group_subject_tag": "[StrategyHub]",
             "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
             "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
             "name": "Elenor Schaefer",
             "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": "2020-09-29T17:03:00-07:00",
             "hashtags": null
           }
         }
       ],
       "wikis": [
         {
           "id": 52691321,
           "object": "wiki_page",
           "created": "2020-09-15T02:30:00-07:00",
           "updated": "2021-03-01T18:07:00-08:00",
           "user_id": 147779411,
           "group_id": 8658933,
           "title": "Including tribe anything from whose market",
           "path": "Including-tribe-anything-from-whose-market",
           "locked": false,
           "rev_count": 43
         }
       ]
     }
   ],
   "end_item": 47,
   "has_more": false,
   "next_page_token": 74,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 47,
   "total_count": 5
}

The Feed Topic Object#

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

Response Attributes

topic Topic object
images optional array of Image Attachment objects

Example Object

{
   "images": [
     {
       "attach_num": 25,
       "content": "",
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 85,
       "id": "",
       "image_height": 34,
       "image_width": 81,
       "message_num": 13,
       "name": "",
       "object": "attachment",
       "sub_type": "",
       "thread_id": 40,
       "thumbnail_url": "",
       "type": "",
       "user_id": 41
     }
   ],
   "topic": {
     "id": 52691321,
     "object": "topic",
     "created": "2020-09-15T02:30:00-07:00",
     "updated": "2021-03-01T18:07:00-08:00",
     "group_id": 8658933,
     "group_subject_tag": "[StrategyHub]",
     "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
     "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
     "name": "Elenor Schaefer",
     "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": "2020-09-29T17:03:00-07:00",
     "hashtags": null
   }
}

The File Object#

The file object.

Response Attributes

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

Methods That Use This Object

Get File	View Method

Example Object

{
   "id": 52691321,
   "object": "file",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "name": "Kelsi Ledner",
   "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
   "size": 132787700,
   "path": "topfolder/subfolder",
   "parent_folder_id": 0,
   "type": "file_type_file",
   "count": 2,
   "media_type": "text/plain",
   "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@..."
}

The File List Object#

File List

Response Attributes

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

Methods That Use This Object

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

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "path": "",
   "files_percentage": 0,
   "files_gigs": "",
   "data": [
     {
       "id": 52691321,
       "object": "file",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Kelsi Ledner",
       "desc": "Tribe anything from whose market pyramid accordingly onto moreover whenever.",
       "size": 132787700,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/52691321/Kelsi%20Ledner?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=LF5x7aMfLeBqN2YBb2W5QbaWJwo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 189377967,
       "object": "file",
       "created": "2020-09-29T17:03:00-07:00",
       "updated": "2022-06-18T23:30:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Lilly Block",
       "desc": "Few why where win most would everybody them backwards this.",
       "size": 98233877,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/189377967/Lilly%20Block?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=chfSbllg5MQwy7qtUhBhVLtETTo%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     },
     {
       "id": 175712125,
       "object": "file",
       "created": "2020-09-08T01:22:00-07:00",
       "updated": "2022-04-15T08:51:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Ludwig Douglas",
       "desc": "Mine year is ever what flock jealousy inside pod without.",
       "size": 197424827,
       "path": "topfolder/subfolder",
       "parent_folder_id": 0,
       "type": "file_type_file",
       "count": 2,
       "media_type": "text/plain",
       "download_url": "https://s3-us-west-1.amazonaws.com/8658933/175712125/Ludwig%20Douglas?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=t3jCZ652kdCBVtZ2PZEod8oFi4I%3D",
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@..."
     }
   ]
}

The Group Object#

The group object.

Response Attributes

id integer	Unique ID of the group object.
object string	group.
created string date-time
updated string date-time
type string	Type of group.
title string	Group title.
name string	Group name.
nice_group_name string	Nice version of the group name.
alias string	Alias.
desc string	Group description, in HTML.
plain_desc string	Plain text version of the description.
subject_tag string	Prepended to subject lines.
footer string	Appended to group messages.
website string	URL of associated website.
announce boolean
moderation string	Can be one of: `moderate_first_message`, `moderated`, `no_moderation`.
new_users_moderated boolean
unmoderate_users_after integer	Unmoderate users after N consecutive approved posts.
restricted boolean
invite_only boolean	If the group is invite-only.
allow_non_subs_to_post boolean
force_html_emails boolean
normalize_html_emails boolean	strip all font/colors/bg stuff from messages.
reply_to string	Can be one of: `group_reply_only_to_sender`, `group_reply_to_followers_only`, `group_reply_to_group`, `group_reply_to_group_and_sender`, `group_reply_to_group_id`, `group_reply_to_moderators`, `group_reply_to_sender`.
remove_other_reply_options boolean
privacy string	Can be one of: `group_privacy_archives`, `group_privacy_none`, `group_privacy_unlisted`, `group_privacy_unlisted_public`, `sub_group_privacy_unlisted_public_archives`.
seperate_footers boolean	Place message footers in separate mime part.
allow_downloads string	If we let members download archives. Can be one of: `allow_downloads_by_members`, `allow_downloads_no`.
members_visible string	Can be one of: `group_view_members_moderators`, `group_view_members_owners`, `group_view_members_subs`.
sub_group_access string	Who can create subgroups. Can be one of: `sub_group_moderators`, `sub_group_owners`, `sub_group_subs`.
calendar_access string	Access control for the calendar. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_mods_folders_only`, `group_access_none`, `group_access_parent`, `group_access_parent_limited`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
files_access string	Access control for the files section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_mods_folders_only`, `group_access_none`, `group_access_parent`, `group_access_parent_limited`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
database_access string	Access control for the database section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_mods_folders_only`, `group_access_none`, `group_access_parent`, `group_access_parent_limited`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
wiki_access string	Access control for the wiki section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_mods_folders_only`, `group_access_none`, `group_access_parent`, `group_access_parent_limited`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
photos_access string	Access control for the photo section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_mods_folders_only`, `group_access_none`, `group_access_parent`, `group_access_parent_limited`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
member_directory_access string	Access control for the member directory section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_mods_folders_only`, `group_access_none`, `group_access_parent`, `group_access_parent_limited`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
polls_access string	Access control for the polls section. Can be one of: `polls_access_limited`, `polls_access_none`, `polls_access_subscribers`.
chat_access string	Access control for the chat section. Can be one of: `group_access_limited`, `group_access_moderators_only`, `group_access_mods_folders_only`, `group_access_none`, `group_access_parent`, `group_access_parent_limited`, `group_access_public`, `group_access_public_limited`, `group_access_subscribers`.
handle_attachments string	Can be one of: `group_attachments_bounced`, `group_attachments_moderated`, `group_attachments_normal`, `group_attachments_stripped`.
plain_text_only boolean
handle_virus string	How we handle messages that may have viruses. Can be one of: `handle_virus_block`, `handle_virus_moderate`.
locked boolean	If the group is locked.
plan string	What plan is group is set to. Can be one of: `group_plan_basic`, `group_plan_enterprise`, `group_plan_premium`.
trial_group boolean	If the group is a free-trial group.
has_cover_photo boolean
has_icon boolean
two_factor_policy string	What plan is group is set to. Can be one of: `group_2fa_policy_all`, `group_2fa_policy_mods`, `group_2fa_policy_none`.
parent_group_id integer
org_id integer
max_photo_size_email string	If we resize photos in emails. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
max_photo_size_photos string	If we resize photos uploaded to the photos section. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
max_photo_size_databases string	If we resize photos uploaded to database tables. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
max_photo_size_wiki_images string	If we resize photos uploaded to the wiki. Can be one of: `max_photo_size_ex_small`, `max_photo_size_large`, `max_photo_size_medium`, `max_photo_size_medium_small`, `max_photo_size_none`, `max_photo_size_small`, `max_photo_size_somewhat_small`.
hash_tags_required boolean	whether messages must be tagged or not.
hash_tag_permissions string	Can be one of: `hash_tag_create_mods_bounce`, `hash_tag_create_mods_remove`, `hash_tag_create_subs`.
bounce_attachments boolean	If out of space, bounce messages with attachments instead of deleting old attachments.
allow_photos_in_files boolean	Whether to allow photos in the Files section.
allow_reposts boolean	If true, members can repost messages. Only used with premium and enterprise groups.
min_days_between_reposts integer	The minimum number of days between reposts.
max_number_of_reposts integer	The maximum number of times a member can repost their message.
email_delivery_default string	Default options for new subscriptions. Can be one of: `email_delivery_digest`, `email_delivery_html_digest`, `email_delivery_none`, `email_delivery_single`, `email_delivery_special`, `email_delivery_summary`.
message_selection_default string	Can be one of: `message_selection_all`, `message_selection_follow_and_first_message`, `message_selection_follow_only`.
auto_follow_replies_default boolean
max_attachment_size_default string	Can be one of: `max_attachment_size_large`, `max_attachment_size_medium`, `max_attachment_size_none`, `max_attachment_size_small`, `max_attachment_size_unlimited`.
default_color string	Can be one of: `color_antique_pink`, `color_apricot`, `color_aquamute`, `color_beige`, `color_bluejean`, `color_blush`, `color_burnt_yellow`, `color_capri_blue`, `color_cerulean_blue`, `color_cherry_blossom`, `color_cloudy_blue`, `color_cucumber`, `color_dark_grey`, `color_dark_orange`, `color_dusty_mauve`, `color_emerald_green`, `color_grape`, `color_green_lantern`, `color_green_sage`, `color_grey_blue`, `color_light_brown`, `color_light_grey`, `color_light_lilac`, `color_lilac`, `color_lips`, `color_melon`, `color_military`, `color_moss_green`, `color_mulbery`, `color_mustard`, `color_none`, `color_orange`, `color_orchid`, `color_peony`, `color_pink`, `color_purple`, `color_purple_blue`, `color_purple_grey`, `color_sage`, `color_sky`, `color_terracotta`, `color_tomato`, `color_yellow`.
default_timezone string
default_time_pref string	Can be one of: `military_time`, `standard_time`.
default_date_pref string	Can be one of: `international_date`, `iso_date`, `us_date`.
default_monday_start boolean
disable_edits boolean	Disable ability for members to edit messages.
disable_no_email boolean	Disable ability for members to be set to No Email.
auto_close_threads boolean	Automatically lock threads after a set number of days.
close_threads_after integer	unit is days.
auto_moderate_threads boolean	Automatically moderate threads after a set number of days.
moderate_threads_after integer	unit is days.
ai_summaries_enabled boolean	If true, members of this (paid) group can generate AI topic summaries.
sticky_wiki_page_id integer	If we've set a wiki page to be displayed at the top of messages.
sub_group_categoryid integer	ID of the subgroupcategory object this group belongs to, if any.
subgroup_allowed_tier_ids optional array of integer	For a subgroup with paid memberships gating: the parent-tier IDs allowed to join it (0 is the default/free tier). Empty/absent means open to every tier. Only meaningful on a subgroup of a paid-memberships parent; omitted for parents and open subgroups.
subs_count integer	Number of subscribers of the group, both normal and pending.
pending_subs_count optional integer	Number of pending subscribers, for restricted groups.
pending_msgs_count optional integer	Number of pending messages requiring approval.
open_chats_count integer	Number of open chats.
threads_count integer	Number of message threads in the archives.
messages_count integer	Number of messages in the archives.
org_domain string
most_recent_message string date-time
cover_photo_url string
icon_url string
group_url string
allow_parent_subs_to_post boolean	If this is a subgroup, we can allow parent subscribers to post messages to it.
send_event_summaries boolean	Send calendar event summary emails.
event_summary_schedule string	Can be one of: `event_summary_biweekly_friday`, `event_summary_monthly`, `event_summary_weekly_friday`, `event_summary_weekly_monday`, `event_summary_weekly_saturday`, `event_summary_weekly_sunday`, `event_summary_weekly_thursday`, `event_summary_weekly_tuesday`, `event_summary_weekly_wednesday`.
send_invites_on_join boolean
perms optional Perms object	If you are subscribed to the group, these are the permissions you have.
email_address string	Email address of the group.
extra_member_data_columns optional array of Database Column objects

Methods That Use This Object

Create Group	View Method
Create Sub Group	View Method
Get Group Settings	View Method
Update Group	View Method
Update Extra Member Column Def	View Method
Add New Group Alias	View Method
Delete Group Alias	View Method

Example Object

{
   "id": 8658933,
   "object": "group",
   "created": "2020-09-15T11:29:00-07:00",
   "updated": "2022-02-12T18:51:00-08:00",
   "type": "group_type_messages",
   "title": "",
   "name": "StrategyHub",
   "nice_group_name": "",
   "alias": "",
   "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
   "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
   "subject_tag": "[StrategyHub]",
   "footer": "This is my\nFooter!!!!",
   "website": "",
   "announce": false,
   "moderation": "moderated",
   "new_users_moderated": true,
   "unmoderate_users_after": 3,
   "restricted": true,
   "invite_only": false,
   "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_by_members",
   "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,
   "two_factor_policy": "group_2fa_policy_none",
   "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,
   "ai_summaries_enabled": false,
   "sticky_wiki_page_id": 0,
   "sub_group_categoryid": 0,
   "subs_count": 541,
   "pending_subs_count": 0,
   "pending_msgs_count": 0,
   "open_chats_count": 0,
   "threads_count": 0,
   "messages_count": 0,
   "org_domain": "",
   "most_recent_message": "2020-09-07T19:38:00-07: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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "email_address": "StrategyHub@groups.io",
   "extra_member_data_columns": [
     {
       "id": 48876437,
       "name": "Text: Lots write point week doctor.",
       "type": "text_column",
       "required": true,
       "color": "color_beige",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Movement whose also it vanish watch these to ever always."
     },
     {
       "id": 161476183,
       "name": "Paragraph: Other few covey range window.",
       "type": "paragraph_column",
       "required": true,
       "color": "color_light_brown",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Silence lastly had what outcome let while school pause up."
     },
     {
       "id": 39354277,
       "name": "Checkbox: Company freedom pout his throw.",
       "type": "checkbox_column",
       "required": true,
       "color": "color_orange",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Quarterly outfit faithful is often part whom these been hourly."
     },
     {
       "id": 8897324,
       "name": "Multiple Choice: Madagascan anyway should late yours.",
       "type": "multiple_choice_column",
       "required": true,
       "color": "color_orchid",
       "choices": [
         "Monthly ball upon almost everything dynasty.",
         "Behalf shall nearly this weekly for.",
         "Anywhere everybody over secondly then boat."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Besides pack when murder her had snore first in limp."
     },
     {
       "id": 159828550,
       "name": "Date: Which these bale nobody few.",
       "type": "date_column",
       "required": true,
       "color": "color_blush",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "How anyone these string life that who result lately yourselves."
     },
     {
       "id": 185149472,
       "name": "Time: Besides later whom for rarely.",
       "type": "time_column",
       "required": true,
       "color": "color_sage",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Each her ski ours host our as did they to."
     },
     {
       "id": 166814414,
       "name": "Address: Bravery where this as cloud.",
       "type": "address_column",
       "required": true,
       "color": "color_cucumber",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Inside since open most you that including fight murder cautiously."
     },
     {
       "id": 102385421,
       "name": "Multi Choice: Another what full her can.",
       "type": "multi_choice_column",
       "required": true,
       "color": "color_aquamute",
       "choices": [
         "Indeed besides motherhood in that nightly.",
         "Limit we kneel herself collect yourselves.",
         "Yourselves Norwegian this fear happily fruit."
       ],
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Pout nature bike moreover from whoever afterwards myself mine to."
     },
     {
       "id": 154317202,
       "name": "Link: Bale sedge Christian would whose.",
       "type": "link_column",
       "required": true,
       "color": "color_military",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Hers pack rhythm that now whose her out infancy somebody."
     },
     {
       "id": 123191768,
       "name": "Image: Today scenic consequently ours eye.",
       "type": "image_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Other other abundant some anywhere this life nevertheless in next."
     },
     {
       "id": 53386358,
       "name": "HTML Paragraph: Nobody what today e.g. loss.",
       "type": "html_paragraph_column",
       "required": true,
       "color": "color_emerald_green",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Spite Philippine before throughout wander of as there next of."
     },
     {
       "id": 45812071,
       "name": "Email: That because am terribly many.",
       "type": "email_column",
       "required": true,
       "color": "color_light_grey",
       "width": 0,
       "default_hidden": false,
       "profile": false,
       "description": "Because anyone does you hungrily can several might who monthly."
     }
   ]
}

The Group Alias Object#

The group alias object.

Response Attributes

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

Example Object

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

The Group Alias List Object#

/getgroupaliases return object.

Response Attributes

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

Methods That Use This Object

Get Group Aliases	View Method

Example Object

{
   "data": [
     {
       "alias_group_id": 70,
       "created": "2009-11-10T15:00:00-08:00",
       "id": 38,
       "name": "example",
       "object": "groupalias",
       "updated": "2009-11-10T15:00:00-08:00"
     }
   ],
   "end_item": 36,
   "has_more": false,
   "next_page_token": 21,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 3,
   "total_count": 50
}

The Group List Object#

/getsubgroups return object.

Response Attributes

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

Methods That Use This Object

Get Sub Groups	View Method

Example Object

{
   "data": [
     {
       "id": 8658933,
       "object": "group",
       "created": "2020-09-15T11:29:00-07:00",
       "updated": "2022-02-12T18:51:00-08:00",
       "type": "group_type_messages",
       "title": "",
       "name": "StrategyHub",
       "nice_group_name": "",
       "alias": "",
       "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
       "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
       "subject_tag": "[StrategyHub]",
       "footer": "This is my\nFooter!!!!",
       "website": "",
       "announce": false,
       "moderation": "moderated",
       "new_users_moderated": true,
       "unmoderate_users_after": 3,
       "restricted": true,
       "invite_only": false,
       "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_by_members",
       "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,
       "two_factor_policy": "group_2fa_policy_none",
       "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,
       "ai_summaries_enabled": false,
       "sticky_wiki_page_id": 0,
       "sub_group_categoryid": 0,
       "subs_count": 541,
       "pending_subs_count": 0,
       "pending_msgs_count": 0,
       "open_chats_count": 0,
       "threads_count": 0,
       "messages_count": 0,
       "org_domain": "",
       "most_recent_message": "2020-09-07T19:38:00-07: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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "email_address": "StrategyHub@groups.io",
       "extra_member_data_columns": [
         {
           "id": 48876437,
           "name": "Text: Lots write point week doctor.",
           "type": "text_column",
           "required": true,
           "color": "color_beige",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Movement whose also it vanish watch these to ever always."
         },
         {
           "id": 161476183,
           "name": "Paragraph: Other few covey range window.",
           "type": "paragraph_column",
           "required": true,
           "color": "color_light_brown",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Silence lastly had what outcome let while school pause up."
         },
         {
           "id": 39354277,
           "name": "Checkbox: Company freedom pout his throw.",
           "type": "checkbox_column",
           "required": true,
           "color": "color_orange",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Quarterly outfit faithful is often part whom these been hourly."
         },
         {
           "id": 8897324,
           "name": "Multiple Choice: Madagascan anyway should late yours.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Monthly ball upon almost everything dynasty.",
             "Behalf shall nearly this weekly for.",
             "Anywhere everybody over secondly then boat."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Besides pack when murder her had snore first in limp."
         },
         {
           "id": 159828550,
           "name": "Date: Which these bale nobody few.",
           "type": "date_column",
           "required": true,
           "color": "color_blush",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "How anyone these string life that who result lately yourselves."
         },
         {
           "id": 185149472,
           "name": "Time: Besides later whom for rarely.",
           "type": "time_column",
           "required": true,
           "color": "color_sage",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Each her ski ours host our as did they to."
         },
         {
           "id": 166814414,
           "name": "Address: Bravery where this as cloud.",
           "type": "address_column",
           "required": true,
           "color": "color_cucumber",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Inside since open most you that including fight murder cautiously."
         },
         {
           "id": 102385421,
           "name": "Multi Choice: Another what full her can.",
           "type": "multi_choice_column",
           "required": true,
           "color": "color_aquamute",
           "choices": [
             "Indeed besides motherhood in that nightly.",
             "Limit we kneel herself collect yourselves.",
             "Yourselves Norwegian this fear happily fruit."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Pout nature bike moreover from whoever afterwards myself mine to."
         },
         {
           "id": 154317202,
           "name": "Link: Bale sedge Christian would whose.",
           "type": "link_column",
           "required": true,
           "color": "color_military",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Hers pack rhythm that now whose her out infancy somebody."
         },
         {
           "id": 123191768,
           "name": "Image: Today scenic consequently ours eye.",
           "type": "image_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Other other abundant some anywhere this life nevertheless in next."
         },
         {
           "id": 53386358,
           "name": "HTML Paragraph: Nobody what today e.g. loss.",
           "type": "html_paragraph_column",
           "required": true,
           "color": "color_emerald_green",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Spite Philippine before throughout wander of as there next of."
         },
         {
           "id": 45812071,
           "name": "Email: That because am terribly many.",
           "type": "email_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Because anyone does you hungrily can several might who monthly."
         }
       ]
     }
   ],
   "end_item": 95,
   "has_more": false,
   "next_page_token": 55,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 71,
   "total_count": 59
}

The Hashtag Object#

The hashtag object.

Response Attributes

id integer	Unique ID of the hashtag object.
object string	hashtag.
created string date-time
group_id integer
name string
alias optional Hashtag object
mods_only_post boolean
mods_only_replies boolean
no_email boolean
moderated boolean
special boolean
replies_unmoderated boolean
locked boolean
until string	Can be one of: `hashtag_delete_day`, `hashtag_delete_forever`, `hashtag_delete_hour`, `hashtag_delete_month`, `hashtag_delete_six_months`, `hashtag_delete_three_months`, `hashtag_delete_week`, `hashtag_delete_year`.
close_instead_of_delete boolean
description string
color_name string	Can be one of: `color_antique_pink`, `color_apricot`, `color_aquamute`, `color_beige`, `color_bluejean`, `color_blush`, `color_burnt_yellow`, `color_capri_blue`, `color_cerulean_blue`, `color_cherry_blossom`, `color_cloudy_blue`, `color_cucumber`, `color_dark_grey`, `color_dark_orange`, `color_dusty_mauve`, `color_emerald_green`, `color_grape`, `color_green_lantern`, `color_green_sage`, `color_grey_blue`, `color_light_brown`, `color_light_grey`, `color_light_lilac`, `color_lilac`, `color_lips`, `color_melon`, `color_military`, `color_moss_green`, `color_mulbery`, `color_mustard`, `color_none`, `color_orange`, `color_orchid`, `color_peony`, `color_pink`, `color_purple`, `color_purple_blue`, `color_purple_grey`, `color_sage`, `color_sky`, `color_terracotta`, `color_tomato`, `color_yellow`.
color_hex string
reply_to string	Can be one of: `thread_reply_group_default`, `thread_reply_only_to_sender`, `thread_reply_to_followers_only`, `thread_reply_to_group`, `thread_reply_to_group_and_sender`, `thread_reply_to_moderators`, `thread_reply_to_sender`.
topic_count integer
last_message_date string date-time
muted boolean nullable	If true, the user is muting this hashtag. This is an optional field.
followed boolean nullable	If true, the user is following this hashtag. This is an optional field.

Methods That Use This Object

New Hashtag	View Method
Update Hashtag	View Method

Example Object

{
   "id": 541,
   "object": "hashtag",
   "created": "2020-09-17T11:22:00-07:00",
   "group_id": 1188,
   "name": "Karl",
   "mods_only_post": false,
   "mods_only_replies": false,
   "no_email": false,
   "moderated": false,
   "special": true,
   "replies_unmoderated": false,
   "locked": true,
   "until": "hashtag_delete_month",
   "close_instead_of_delete": true,
   "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
   "color_name": "pink",
   "color_hex": "#f39de4",
   "reply_to": "thread_reply_to_sender",
   "topic_count": 1789,
   "last_message_date": "2020-09-08T01:22:00-07:00",
   "muted": null,
   "followed": null
}

The Hashtag List Object#

Hashtag List

Response Attributes

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

Methods That Use This Object

Get Hashtags	View Method

Example Object

{
   "data": [
     {
       "id": 541,
       "object": "hashtag",
       "created": "2020-09-17T11:22:00-07:00",
       "group_id": 1188,
       "name": "Karl",
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": true,
       "replies_unmoderated": false,
       "locked": true,
       "until": "hashtag_delete_month",
       "close_instead_of_delete": true,
       "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
       "color_name": "pink",
       "color_hex": "#f39de4",
       "reply_to": "thread_reply_to_sender",
       "topic_count": 1789,
       "last_message_date": "2020-09-08T01:22:00-07:00",
       "muted": null,
       "followed": null
     }
   ],
   "end_item": 21,
   "has_more": false,
   "next_page_token": 46,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 52,
   "total_count": 35
}

The Image Attachment Object#

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

Response Attributes

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

Example Object

{
   "attach_num": 11,
   "content": "",
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 86,
   "id": "",
   "image_height": 91,
   "image_width": 47,
   "message_num": 94,
   "name": "",
   "object": "attachment",
   "sub_type": "",
   "thread_id": 59,
   "thumbnail_url": "",
   "type": "",
   "user_id": 44
}

The Login Object#

The login object.

Response Attributes

user User object
token optional string	If using the token login, this is the token to pass in.

Methods That Use This Object

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

Example Object

{
   "token": "aabbffed2213234",
   "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_default"
   }
}

The Member Info Object#

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

Response Attributes

id integer	Unique ID of the member_info object.
object string	member_info.
created string date-time	The time that this object was created.
updated string date-time	The time that this object was last updated.
user_id integer	ID of the member.
group_id integer	ID of the group.
group_name string	Name of the group.
status optional string	Member status. Can be one of: `sub_status_approved_awaiting_payment`, `sub_status_banned`, `sub_status_normal`, `sub_status_pending`.
post_status optional string	Posting status. Can be one of: `sub_poststatus_allowed`, `sub_poststatus_mod_first_message`, `sub_poststatus_mod_started_topics`, `sub_poststatus_moderated`, `sub_poststatus_newusermoderated`, `sub_poststatus_normal`, `sub_poststatus_notallowed`.
email_delivery optional string	Email delivery. Can be one of: `email_delivery_digest`, `email_delivery_html_digest`, `email_delivery_none`, `email_delivery_single`, `email_delivery_special`, `email_delivery_summary`.
message_selection optional string	Message selection. Can be one of: `message_selection_all`, `message_selection_follow_and_first_message`, `message_selection_follow_only`.
auto_follow_replies optional boolean
max_attachment_size optional string	Max attachment size. Can be one of: `max_attachment_size_large`, `max_attachment_size_medium`, `max_attachment_size_none`, `max_attachment_size_small`, `max_attachment_size_unlimited`.
approved_posts optional integer	The count of consecutive approved posts. Only applicable when post_status is `sub_poststatus_newusermoderated`.
mod_status optional string	Moderator data. Can be one of: `sub_modstatus_moderator`, `sub_modstatus_none`, `sub_modstatus_owner`.
pending_msg_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
pending_sub_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
sub_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
storage_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
sub_group_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
message_report_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
account_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
mod_permissions optional string	Can be more than one of: `sub_perm_banmembers`, `sub_perm_billing`, `sub_perm_editarchives`, `sub_perm_groupsettings`, `sub_perm_integrations`, `sub_perm_invitemembers`, `sub_perm_makemoderator`, `sub_perm_managehashtags`, `sub_perm_managepaidsubscriptions`, `sub_perm_managesubgroups`, `sub_perm_modsub`, `sub_perm_none`, `sub_perm_pendingmembers`, `sub_perm_pendingmsgs`, `sub_perm_removemembers`, `sub_perm_viewmembers`.
owner_msg_notify optional string	Can be one of: `sub_ownermsg_notify_all`, `sub_ownermsg_notify_none`, `sub_ownermsg_notify_subs`.
chat_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
photo_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
file_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
wiki_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
database_notify optional string	Can be one of: `sub_notify_app_only`, `sub_notify_email_and_app`, `sub_notify_email_only`, `sub_notify_none`.
email optional string	The email address of the member.
user_status optional string	User status. Can be one of: `user_status_bounced`, `user_status_bouncing`, `user_status_confirmed`, `user_status_failed_reverify`, `user_status_inactive`, `user_status_not_confirmed`.
user_name string	User name.
timezone optional string	Time zone.
full_name string	Full name.
about_me optional string	About me, in HTML format.
location optional string	Location.
website optional string	Website, typically a URL.
profile_photo_url optional string	Empty if no profile photo.
profile_privacy optional string	Profile privacy. Can be one of: `profile_members`, `profile_private`, `profile_public`.
dont_munge_message_id optional boolean
use_signature optional boolean	Insert the signature into messages posted from the Groups.io website.
use_signature_email optional boolean	Insert the signature into messages sent via email.
signature optional string	Signature.
moderator_notes optional string	Any moderator notes. The moderator_notes field is only set when an account with the appropriate permissions requests this.
moderator_notes_updated optional string date-time	The last time the moderator_notes field was updated. The moderator_notes_updated field is only set when an account with the appropriate permissions requests this.
color optional string	Member color. Can be one of: `color_antique_pink`, `color_apricot`, `color_aquamute`, `color_beige`, `color_bluejean`, `color_blush`, `color_burnt_yellow`, `color_capri_blue`, `color_cerulean_blue`, `color_cherry_blossom`, `color_cloudy_blue`, `color_cucumber`, `color_dark_grey`, `color_dark_orange`, `color_dusty_mauve`, `color_emerald_green`, `color_grape`, `color_green_lantern`, `color_green_sage`, `color_grey_blue`, `color_light_brown`, `color_light_grey`, `color_light_lilac`, `color_lilac`, `color_lips`, `color_melon`, `color_military`, `color_moss_green`, `color_mulbery`, `color_mustard`, `color_none`, `color_orange`, `color_orchid`, `color_peony`, `color_pink`, `color_purple`, `color_purple_blue`, `color_purple_grey`, `color_sage`, `color_sky`, `color_terracotta`, `color_tomato`, `color_yellow`.
num_drafts optional integer	The number of drafts this person has open in this group. This field is only set by the `getsubscriptions` endpoint.
pending_subs optional integer	The number of pending subscribers this group has.
pending_msgs optional integer	The number of pending messages this group has.
cover_photo_url string	URL of the group cover photo.
icon_url string	URL of the group icon.
nice_group_name string	Nice version of the group name.
subs_count integer	Number of subscribers in the group.
most_recent_message string date-time
perms optional Perms object	Group permissions this member has.
delivery_info optional Delivery Info object	Delivery information.
member_labels optional array of MemberLabel objects	Member labels.
extra_member_data optional array of Database Value objects	Extra member data.

Methods That Use This Object

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

Example Object

{
   "id": 93846546,
   "object": "member_info",
   "created": "2020-09-09T04:11:00-07:00",
   "updated": "2022-06-08T07:16:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "group_name": "StrategyHub",
   "status": "sub_status_normal",
   "post_status": "sub_poststatus_newusermoderated",
   "email_delivery": "email_delivery_digest",
   "message_selection": "message_selection_follow_and_first_message",
   "auto_follow_replies": false,
   "max_attachment_size": "max_attachment_size_medium",
   "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "profile_privacy": "profile_private",
   "dont_munge_message_id": false,
   "use_signature": false,
   "use_signature_email": false,
   "signature": "In hotel furniture anyone weakly besides",
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "member_labels": [
     {
       "id": 726,
       "object": "memberlabel",
       "created": "2020-09-29T22:19:00Z",
       "group_id": 1857,
       "name": "Florida",
       "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
       "color_name": "green-sage",
       "color_hex": "#9fc4ac"
     },
     {
       "id": 1594,
       "object": "memberlabel",
       "created": "2020-09-24T02:24:00Z",
       "group_id": 42,
       "name": "Russel",
       "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
       "color_name": "purple",
       "color_hex": "#837fd5"
     },
     {
       "id": 1189,
       "object": "memberlabel",
       "created": "2020-09-12T02:11:00Z",
       "group_id": 1474,
       "name": "Meta",
       "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
       "color_name": "sky",
       "color_hex": "#9cc7df"
     }
   ],
   "extra_member_data": [
     {
       "col_id": 48876437,
       "col_type": "text_column",
       "text": "To firstly unlock while host himself me purely as whose."
     },
     {
       "col_id": 161476183,
       "col_type": "paragraph_column",
       "text": "Yet few mustering example will addition yearly since in these."
     },
     {
       "col_id": 39354277,
       "col_type": "checkbox_column",
       "checked": false
     },
     {
       "col_id": 8897324,
       "col_type": "multiple_choice_column",
       "multi_choice": [
         0
       ]
     },
     {
       "col_id": 159828550,
       "col_type": "date_column",
       "date": "1923-10-16T17:57:55.797000001Z"
     },
     {
       "col_id": 185149472,
       "col_type": "time_column",
       "time": "1929-03-30T18:00:36.790929649Z"
     },
     {
       "col_id": 166814414,
       "col_type": "address_column",
       "street_address1": "Premier Medical Group",
       "street_address2": "3701 DAUPHIN ST",
       "city": "MOBILE",
       "state": "AL",
       "zip": "36608-1756",
       "lat": 30.6866076,
       "lng": -88.13019249999999
     },
     {
       "col_id": 102385421,
       "col_type": "multi_choice_column",
       "multi_choice": [
         0,
         1,
         2
       ]
     },
     {
       "col_id": 154317202,
       "col_type": "link_column",
       "title": "To say poorly out according abundant unless nervously string lastly.",
       "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
       "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
     },
     {
       "col_id": 123191768,
       "col_type": "image_column",
       "url": "https://picsum.photos/id/27/187/110",
       "image_name": "Lately blazer with wild hourly there she it infrequently power."
     },
     {
       "col_id": 53386358,
       "col_type": "html_paragraph_column",
       "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
     },
     {
       "col_id": 45812071,
       "col_type": "email_column",
       "text": "brantkozey@bernhard.com"
     }
   ]
}

The Member Info List Object#

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

Response Attributes

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

Methods That Use This Object

Chat Members	View Method
Get Member Directory	View Method
Get Members	View Method
Search Member Directory	View Method
Search Members	View Method
Get Subscriptions	View Method

Example Object

{
   "data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "end_item": 97,
   "has_more": false,
   "next_page_token": 18,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 81,
   "total_count": 10
}

The Member Notice Object#

The member notice object.

Response Attributes

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

Methods That Use This Object

New Member Notice	View Method
Update Member Notice	View Method

Example Object

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

The Member Notice List Object#

Member Notice List

Response Attributes

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

Methods That Use This Object

Get Member Notices	View Method

Example Object

{
   "data": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 63,
       "guidelines_monthly_subject": "",
       "id": 68,
       "is_default": false,
       "message": "",
       "name": "",
       "object": "member_notice",
       "private": false,
       "send_monthly": false,
       "send_monthly_special": false,
       "send_on_join": false,
       "subject": "",
       "type": "member_notice_banned",
       "updated": "2009-11-10T15:00:00-08:00"
     }
   ],
   "end_item": 47,
   "has_more": false,
   "next_page_token": 53,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 7,
   "total_count": 50
}

The MemberLabel Object#

The member label object.

Response Attributes

id integer	Unique ID of the memberlabel object.
object string	memberlabel.
created string date-time
group_id integer
name string
description string
color_name string	Can be one of: `color_antique_pink`, `color_apricot`, `color_aquamute`, `color_beige`, `color_bluejean`, `color_blush`, `color_burnt_yellow`, `color_capri_blue`, `color_cerulean_blue`, `color_cherry_blossom`, `color_cloudy_blue`, `color_cucumber`, `color_dark_grey`, `color_dark_orange`, `color_dusty_mauve`, `color_emerald_green`, `color_grape`, `color_green_lantern`, `color_green_sage`, `color_grey_blue`, `color_light_brown`, `color_light_grey`, `color_light_lilac`, `color_lilac`, `color_lips`, `color_melon`, `color_military`, `color_moss_green`, `color_mulbery`, `color_mustard`, `color_none`, `color_orange`, `color_orchid`, `color_peony`, `color_pink`, `color_purple`, `color_purple_blue`, `color_purple_grey`, `color_sage`, `color_sky`, `color_terracotta`, `color_tomato`, `color_yellow`.
color_hex string

Example Object

{
   "color_hex": "",
   "color_name": "color_antique_pink",
   "created": "2009-11-10T15:00:00-08:00",
   "description": "",
   "group_id": 96,
   "id": 44,
   "name": "",
   "object": "memberlabel"
}

The MemberLabel List Object#

MemberLabel List

Response Attributes

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

Example Object

{
   "data": [
     {
       "color_hex": "",
       "color_name": "color_antique_pink",
       "created": "2009-11-10T15:00:00-08:00",
       "description": "",
       "group_id": 89,
       "id": 47,
       "name": "",
       "object": "memberlabel"
     }
   ],
   "end_item": 27,
   "has_more": false,
   "next_page_token": 53,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 18,
   "total_count": 67
}

The Message Object#

The message object.

Response Attributes

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

Methods That Use This Object

Get Message	View Method

Example Object

{
   "attachments": [
     {
       "download_url": "",
       "filename": "",
       "id": 24,
       "image_thumbnail_url": "",
       "media_type": ""
     }
   ],
   "body": "",
   "can_repost": false,
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 1,
   "has_liked": false,
   "hashtags": [
     {
       "id": 541,
       "object": "hashtag",
       "created": "2020-09-17T11:22:00-07:00",
       "group_id": 1188,
       "name": "Karl",
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": true,
       "replies_unmoderated": false,
       "locked": true,
       "until": "hashtag_delete_month",
       "close_instead_of_delete": true,
       "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
       "color_name": "pink",
       "color_hex": "#f39de4",
       "reply_to": "thread_reply_to_sender",
       "topic_count": 1789,
       "last_message_date": "2020-09-08T01:22:00-07:00",
       "muted": null,
       "followed": null
     }
   ],
   "id": 25,
   "is_closed": false,
   "is_moderated": false,
   "is_plain_text": false,
   "is_reply": false,
   "msg_num": 60,
   "name": "",
   "num_likes": 62,
   "object": "message",
   "poll_id": 71,
   "profile_photo_url": "",
   "quoted": "",
   "raw_message": "",
   "remainder": "",
   "reply_to": "group_reply_only_to_sender",
   "snippet": "",
   "subject": "",
   "subject_with_tags": "",
   "topic_id": 32,
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 89
}

The Message Attachment Object#

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

Response Attributes

id integer	The ID of the attachment.
media_type string	The media type of the attachment, lowercased.
download_url string	URL to download the attachment.
image_thumbnail_url string	If this is an image, the URL to get the image thumbnail for display.
filename string	The filename of the attachment.

Example Object

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

The Message History Object#

The message history object.

Response Attributes

object string	message_history.
month_counts array of Month Count objects nullable	Array of sets of 12 month_count objects.
tz_offset integer	Timezone offset, in minutes difference to UTC.

Methods That Use This Object

Get Message History	View Method

Example Object

{
   "month_counts": [
     {
       "month": 84,
       "msgs_sent": 32,
       "object": "month_count",
       "year": 83
     }
   ],
   "object": "message_history",
   "tz_offset": 53
}

The Message List Object#

Message List

Response Attributes

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

Methods That Use This Object

Get Topic	View Method
Get Messages	View Method

Example Object

{
   "cover_photo_url": "",
   "data": [
     {
       "attachments": [
         {
           "download_url": "",
           "filename": "",
           "id": 71,
           "image_thumbnail_url": "",
           "media_type": ""
         }
       ],
       "body": "",
       "can_repost": false,
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 88,
       "has_liked": false,
       "hashtags": [
         {
           "id": 541,
           "object": "hashtag",
           "created": "2020-09-17T11:22:00-07:00",
           "group_id": 1188,
           "name": "Karl",
           "mods_only_post": false,
           "mods_only_replies": false,
           "no_email": false,
           "moderated": false,
           "special": true,
           "replies_unmoderated": false,
           "locked": true,
           "until": "hashtag_delete_month",
           "close_instead_of_delete": true,
           "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
           "color_name": "pink",
           "color_hex": "#f39de4",
           "reply_to": "thread_reply_to_sender",
           "topic_count": 1789,
           "last_message_date": "2020-09-08T01:22:00-07:00",
           "muted": null,
           "followed": null
         }
       ],
       "id": 27,
       "is_closed": false,
       "is_moderated": false,
       "is_plain_text": false,
       "is_reply": false,
       "msg_num": 51,
       "name": "",
       "num_likes": 5,
       "object": "message",
       "poll_id": 62,
       "profile_photo_url": "",
       "quoted": "",
       "raw_message": "",
       "remainder": "",
       "reply_to": "group_reply_only_to_sender",
       "snippet": "",
       "subject": "",
       "subject_with_tags": "",
       "topic_id": 35,
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 44
     }
   ],
   "end_item": 88,
   "group": {
     "id": 8658933,
     "object": "group",
     "created": "2020-09-15T11:29:00-07:00",
     "updated": "2022-02-12T18:51:00-08:00",
     "type": "group_type_messages",
     "title": "",
     "name": "StrategyHub",
     "nice_group_name": "",
     "alias": "",
     "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
     "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
     "subject_tag": "[StrategyHub]",
     "footer": "This is my\nFooter!!!!",
     "website": "",
     "announce": false,
     "moderation": "moderated",
     "new_users_moderated": true,
     "unmoderate_users_after": 3,
     "restricted": true,
     "invite_only": false,
     "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_by_members",
     "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,
     "two_factor_policy": "group_2fa_policy_none",
     "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,
     "ai_summaries_enabled": false,
     "sticky_wiki_page_id": 0,
     "sub_group_categoryid": 0,
     "subs_count": 541,
     "pending_subs_count": 0,
     "pending_msgs_count": 0,
     "open_chats_count": 0,
     "threads_count": 0,
     "messages_count": 0,
     "org_domain": "",
     "most_recent_message": "2020-09-07T19:38:00-07: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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "email_address": "StrategyHub@groups.io",
     "extra_member_data_columns": [
       {
         "id": 48876437,
         "name": "Text: Lots write point week doctor.",
         "type": "text_column",
         "required": true,
         "color": "color_beige",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Movement whose also it vanish watch these to ever always."
       },
       {
         "id": 161476183,
         "name": "Paragraph: Other few covey range window.",
         "type": "paragraph_column",
         "required": true,
         "color": "color_light_brown",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Silence lastly had what outcome let while school pause up."
       },
       {
         "id": 39354277,
         "name": "Checkbox: Company freedom pout his throw.",
         "type": "checkbox_column",
         "required": true,
         "color": "color_orange",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Quarterly outfit faithful is often part whom these been hourly."
       },
       {
         "id": 8897324,
         "name": "Multiple Choice: Madagascan anyway should late yours.",
         "type": "multiple_choice_column",
         "required": true,
         "color": "color_orchid",
         "choices": [
           "Monthly ball upon almost everything dynasty.",
           "Behalf shall nearly this weekly for.",
           "Anywhere everybody over secondly then boat."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Besides pack when murder her had snore first in limp."
       },
       {
         "id": 159828550,
         "name": "Date: Which these bale nobody few.",
         "type": "date_column",
         "required": true,
         "color": "color_blush",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "How anyone these string life that who result lately yourselves."
       },
       {
         "id": 185149472,
         "name": "Time: Besides later whom for rarely.",
         "type": "time_column",
         "required": true,
         "color": "color_sage",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Each her ski ours host our as did they to."
       },
       {
         "id": 166814414,
         "name": "Address: Bravery where this as cloud.",
         "type": "address_column",
         "required": true,
         "color": "color_cucumber",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Inside since open most you that including fight murder cautiously."
       },
       {
         "id": 102385421,
         "name": "Multi Choice: Another what full her can.",
         "type": "multi_choice_column",
         "required": true,
         "color": "color_aquamute",
         "choices": [
           "Indeed besides motherhood in that nightly.",
           "Limit we kneel herself collect yourselves.",
           "Yourselves Norwegian this fear happily fruit."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Pout nature bike moreover from whoever afterwards myself mine to."
       },
       {
         "id": 154317202,
         "name": "Link: Bale sedge Christian would whose.",
         "type": "link_column",
         "required": true,
         "color": "color_military",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Hers pack rhythm that now whose her out infancy somebody."
       },
       {
         "id": 123191768,
         "name": "Image: Today scenic consequently ours eye.",
         "type": "image_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Other other abundant some anywhere this life nevertheless in next."
       },
       {
         "id": 53386358,
         "name": "HTML Paragraph: Nobody what today e.g. loss.",
         "type": "html_paragraph_column",
         "required": true,
         "color": "color_emerald_green",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Spite Philippine before throughout wander of as there next of."
       },
       {
         "id": 45812071,
         "name": "Email: That because am terribly many.",
         "type": "email_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Because anyone does you hungrily can several might who monthly."
       }
     ]
   },
   "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,
     "ask_visible": 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_reply": 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,
     "can_ask": true
   },
   "has_more": false,
   "next_page_token": 13,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 13,
   "sub_data": [
     {
       "id": 93846546,
       "object": "member_info",
       "created": "2020-09-09T04:11:00-07:00",
       "updated": "2022-06-08T07:16:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "group_name": "StrategyHub",
       "status": "sub_status_normal",
       "post_status": "sub_poststatus_newusermoderated",
       "email_delivery": "email_delivery_digest",
       "message_selection": "message_selection_follow_and_first_message",
       "auto_follow_replies": false,
       "max_attachment_size": "max_attachment_size_medium",
       "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
       "profile_privacy": "profile_private",
       "dont_munge_message_id": false,
       "use_signature": false,
       "use_signature_email": false,
       "signature": "In hotel furniture anyone weakly besides",
       "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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "member_labels": [
         {
           "id": 726,
           "object": "memberlabel",
           "created": "2020-09-29T22:19:00Z",
           "group_id": 1857,
           "name": "Florida",
           "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
           "color_name": "green-sage",
           "color_hex": "#9fc4ac"
         },
         {
           "id": 1594,
           "object": "memberlabel",
           "created": "2020-09-24T02:24:00Z",
           "group_id": 42,
           "name": "Russel",
           "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
           "color_name": "purple",
           "color_hex": "#837fd5"
         },
         {
           "id": 1189,
           "object": "memberlabel",
           "created": "2020-09-12T02:11:00Z",
           "group_id": 1474,
           "name": "Meta",
           "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
           "color_name": "sky",
           "color_hex": "#9cc7df"
         }
       ],
       "extra_member_data": [
         {
           "col_id": 48876437,
           "col_type": "text_column",
           "text": "To firstly unlock while host himself me purely as whose."
         },
         {
           "col_id": 161476183,
           "col_type": "paragraph_column",
           "text": "Yet few mustering example will addition yearly since in these."
         },
         {
           "col_id": 39354277,
           "col_type": "checkbox_column",
           "checked": false
         },
         {
           "col_id": 8897324,
           "col_type": "multiple_choice_column",
           "multi_choice": [
             0
           ]
         },
         {
           "col_id": 159828550,
           "col_type": "date_column",
           "date": "1923-10-16T17:57:55.797000001Z"
         },
         {
           "col_id": 185149472,
           "col_type": "time_column",
           "time": "1929-03-30T18:00:36.790929649Z"
         },
         {
           "col_id": 166814414,
           "col_type": "address_column",
           "street_address1": "Premier Medical Group",
           "street_address2": "3701 DAUPHIN ST",
           "city": "MOBILE",
           "state": "AL",
           "zip": "36608-1756",
           "lat": 30.6866076,
           "lng": -88.13019249999999
         },
         {
           "col_id": 102385421,
           "col_type": "multi_choice_column",
           "multi_choice": [
             0,
             1,
             2
           ]
         },
         {
           "col_id": 154317202,
           "col_type": "link_column",
           "title": "To say poorly out according abundant unless nervously string lastly.",
           "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
           "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
         },
         {
           "col_id": 123191768,
           "col_type": "image_column",
           "url": "https://picsum.photos/id/27/187/110",
           "image_name": "Lately blazer with wild hourly there she it infrequently power."
         },
         {
           "col_id": 53386358,
           "col_type": "html_paragraph_column",
           "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
         },
         {
           "col_id": 45812071,
           "col_type": "email_column",
           "text": "brantkozey@bernhard.com"
         }
       ]
     }
   ],
   "topic": {
     "id": 52691321,
     "object": "topic",
     "created": "2020-09-15T02:30:00-07:00",
     "updated": "2021-03-01T18:07:00-08:00",
     "group_id": 8658933,
     "group_subject_tag": "[StrategyHub]",
     "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
     "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
     "name": "Elenor Schaefer",
     "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": "2020-09-29T17:03:00-07:00",
     "hashtags": null
   },
   "total_count": 37
}

The Message Search Result Object#

The message search result object.

Response Attributes

id integer
object string	message_search_result.
created string date-time
updated string date-time
group_id integer
topic_id integer
summary string	Results summary, in HTML.
subject string	Subject of the message.
body string	Plain text body of the message, restricted to the first 500,000 bytes.
user_id integer
profile_photo_url string	If not empty then there is a profile photo associated with this votor.
name string	Name of the person who voted.
can_view_profile boolean	If the person viewing this poll can view the profile.
rev_count integer	If > 0, then this message has been edited.
msg_num integer	The msg number of the message, if this is a message.
num_msgs_in_topic integer
is_closed boolean	If the topic this message is a part of is closed.
is_moderated boolean	If the topic this message is a part of is moderated.
is_sticky boolean	If this topic has been marked as sticky.
has_attachments boolean	If this message has attachments.
hashtags array of Hashtag objects nullable

Example Object

{
   "body": "",
   "can_view_profile": false,
   "created": "2009-11-10T15:00:00-08:00",
   "group_id": 54,
   "has_attachments": false,
   "hashtags": [
     {
       "id": 541,
       "object": "hashtag",
       "created": "2020-09-17T11:22:00-07:00",
       "group_id": 1188,
       "name": "Karl",
       "mods_only_post": false,
       "mods_only_replies": false,
       "no_email": false,
       "moderated": false,
       "special": true,
       "replies_unmoderated": false,
       "locked": true,
       "until": "hashtag_delete_month",
       "close_instead_of_delete": true,
       "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
       "color_name": "pink",
       "color_hex": "#f39de4",
       "reply_to": "thread_reply_to_sender",
       "topic_count": 1789,
       "last_message_date": "2020-09-08T01:22:00-07:00",
       "muted": null,
       "followed": null
     }
   ],
   "id": 25,
   "is_closed": false,
   "is_moderated": false,
   "is_sticky": false,
   "msg_num": 61,
   "name": "",
   "num_msgs_in_topic": 62,
   "object": "message_search_result",
   "profile_photo_url": "",
   "rev_count": 49,
   "subject": "",
   "summary": "",
   "topic_id": 82,
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 1
}

The Message Search Results List Object#

Message Search Results List

Response Attributes

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

Methods That Use This Object

Search Archives	View Method

Example Object

{
   "can_view_profile": false,
   "collapse_topics": false,
   "data": [
     {
       "body": "",
       "can_view_profile": false,
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 92,
       "has_attachments": false,
       "hashtags": [
         {
           "id": 541,
           "object": "hashtag",
           "created": "2020-09-17T11:22:00-07:00",
           "group_id": 1188,
           "name": "Karl",
           "mods_only_post": false,
           "mods_only_replies": false,
           "no_email": false,
           "moderated": false,
           "special": true,
           "replies_unmoderated": false,
           "locked": true,
           "until": "hashtag_delete_month",
           "close_instead_of_delete": true,
           "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
           "color_name": "pink",
           "color_hex": "#f39de4",
           "reply_to": "thread_reply_to_sender",
           "topic_count": 1789,
           "last_message_date": "2020-09-08T01:22:00-07:00",
           "muted": null,
           "followed": null
         }
       ],
       "id": 29,
       "is_closed": false,
       "is_moderated": false,
       "is_sticky": false,
       "msg_num": 19,
       "name": "",
       "num_msgs_in_topic": 65,
       "object": "message_search_result",
       "profile_photo_url": "",
       "rev_count": 5,
       "subject": "",
       "summary": "",
       "topic_id": 82,
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 98
     }
   ],
   "end_date": "2009-11-10T15:00:00-08:00",
   "end_item": 89,
   "exclude_sigs": false,
   "has_more": false,
   "hashtag": {
     "id": 541,
     "object": "hashtag",
     "created": "2020-09-17T11:22:00-07:00",
     "group_id": 1188,
     "name": "Karl",
     "mods_only_post": false,
     "mods_only_replies": false,
     "no_email": false,
     "moderated": false,
     "special": true,
     "replies_unmoderated": false,
     "locked": true,
     "until": "hashtag_delete_month",
     "close_instead_of_delete": true,
     "description": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever. E.g. fear usually body kilometer nightly child so firstly he. Next each secondly must catch politely sleepy where i.e. inquisitively. Yours wisp regularly nice cackle ourselves heavily now this our. Yearly what few why where win most would everybody them.",
     "color_name": "pink",
     "color_hex": "#f39de4",
     "reply_to": "thread_reply_to_sender",
     "topic_count": 1789,
     "last_message_date": "2020-09-08T01:22:00-07:00",
     "muted": null,
     "followed": null
   },
   "name": "",
   "next_page_token": 43,
   "object": "list",
   "poster_user_id": 55,
   "preset_date_range": "",
   "profile_photo_url": "",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_date": "2009-11-10T15:00:00-08:00",
   "start_item": 83,
   "total_count": 90
}

The Month Count Object#

The month count object.

Response Attributes

object string	month_count.
year integer	Year.
month integer	Month.
msgs_sent integer	Number of messages sent that month.

Example Object

{
   "month": 38,
   "msgs_sent": 29,
   "object": "month_count",
   "year": 53
}

The Oauth Login Object#

The Oauth Login object.

Response Attributes

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

Methods That Use This Object

Facebook Login Start	View Method
Google Login Start	View Method

Example Object

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

The Org Object#

The org object.

Response Attributes

id integer	Unique ID of the org object.
object string	org.
created string date-time	Time object was created.
updated string date-time	Time object was last updated.
title string	Title of the organization.
domain string	Domain of the organization.
parent_group_id integer	ID of the parent group for this org (each org has 1 parent group).
logged_out_wiki_page_id integer	If not 0, the ID of the WikiPage to display for logged out people visiting the domain.
default_timezone string	For users created in this timezone.
disable_signup boolean	Don't allow access to any group page at all if not signed in.
disable_plus_one boolean	Don't treat +1 emails as likes.
ga_code string	Google Analytics code.
login_page_text string	Replace the standard text at the bottom of the login page.
no_account_text string	Text displayed on the send login link page.
sso_provider string	If this org uses an SSO identity provider. Can be one of: `no_sso`, `sso_auth0`, `sso_club_express`, `sso_growth_zone`, `sso_member_clicks`, `sso_mini_orange`, `sso_novi_ams`, `sso_test`, `sso_your_membership`, `ssosaml_generic`, `ssosaml_google`, `ssosaml_microsoft`, `ssosaml_okta`, `ssosaml_one_login`, `ssosaml_ping_identity`, `ssosamladfs`.
sso_client_id string	SSO Client ID.
sso_client_secret string	SSO Client Secret.
sso_domain string	SSO Domain.

Methods That Use This Object

Get Org	View Method

Example Object

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

The Pagination Object#

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

Response Attributes

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

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc"
}

The Past Member Object#

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

Response Attributes

id integer
object string	past_member.
created string date-time	The time that this record was created.
action string	The reason for the unsubscription. Can be one of: `accepted_invitation`, `added_album`, `added_alias`, `added_banned_domain`, `added_bluesky_integration`, `added_dir`, `added_email_integration`, `added_event`, `added_facebook_integration`, `added_file`, `added_github_integration`, `added_group_alias`, `added_group_notice`, `added_hashtag`, `added_instagram_integration`, `added_member`, `added_member_label`, `added_photo`, `added_repeat_event`, `added_row`, `added_rss_integration`, `added_table`, `added_trello_integration`, `added_webhook`, `added_wiki_image`, `added_wiki_page`, `applied`, `approved_member`, `approved_pending_message`, `attachments_deleted_for_space`, `attempt_sub_banned_member`, `attempted_banned_domain_owner`, `attempted_banned_domain_post`, `attempted_banned_domain_registration`, `attempted_file_add_with_virus`, `bad_expired_thread`, `banned_by_system`, `banned_member`, `bounced_user`, `bouncing_user`, `canceled_event`, `changed_email`, `changed_fullname`, `changed_payer`, `changed_thread_replyto`, `changed_thread_subject`, `changed_username`, `claimed_pending_member`, `claimed_pending_message`, `closed_thread`, `color_changed`, `confirmed_account`, `created_group`, `created_subgroup`, `deleted_account`, `deleted_album`, `deleted_alias`, `deleted_attachment`, `deleted_banned_domain`, `deleted_chat_message`, `deleted_dir`, `deleted_event`, `deleted_file`, `deleted_following_repeat_event`, `deleted_group_alias`, `deleted_group_notice`, `deleted_message`, `deleted_message_edit`, `deleted_pending_member`, `deleted_pending_message`, `deleted_photo`, `deleted_repeat_event`, `deleted_row`, `deleted_subgroup`, `deleted_table`, `deleted_thread`, `deleted_wiki_image`, `deleted_wiki_page`, `deleted_wiki_rev`, `delivery_changed`, `delivery_changed_by_moderator`, `donation_closed`, `donation_reopened`, `donation_requested`, `donation_updated`, `edited_album`, `edited_bluesky_integration`, `edited_email_integration`, `edited_extra_data`, `edited_facebook_integration`, `edited_github_integration`, `edited_group`, `edited_group_notice`, `edited_hashtag`, `edited_instagram_integration`, `edited_member_label`, `edited_message`, `edited_message_no_send_unused`, `edited_moderator_note`, `edited_photo`, `edited_rss_integration`, `edited_trello_integration`, `edited_webhook`, `event_changed_guests`, `event_changed_rsvp`, `event_edited_comment`, `event_moved_from_waitlist`, `event_removed_rsvp`, `event_rsvp_maybe`, `event_rsvp_no`, `event_rsvp_yes`, `expired_hashtag`, `expired_member`, `expired_pending_message`, `exported_group`, `extra_data_changed_by_moderator`, `extra_storage_added`, `extra_storage_removed`, `guidelines_sent`, `invited_member`, `joined`, `left`, `locked_event`, `member_donated`, `member_donation_failed`, `member_label_changed`, `member_sponsored`, `member_sponsorship_failed`, `member_tier_canceled`, `member_tier_chargeback`, `member_tier_downgrade_applied`, `member_tier_downgrade_released`, `member_tier_downgrade_scheduled`, `member_tier_expired`, `member_tier_manually_granted`, `member_tier_manually_revoked`, `member_tier_past_due`, `member_tier_payment_recovered`, `member_tier_refunded`, `member_tier_resumed`, `member_tier_subscribe_orphan_cleaned`, `member_tier_subscribed`, `member_tier_upgraded`, `merge_threads`, `message_to_attendees`, `mod_changed_email`, `mod_changed_fullname`, `moderated_thread`, `moderator_changed`, `modified_dir`, `modified_event`, `modified_file`, `modified_repeat_event`, `modified_row`, `modified_table`, `modified_wiki_page`, `monthly_reminder_sent`, `moved_dir`, `moved_file`, `moved_photo`, `notifications_changed`, `notifications_changed_by_moderator`, `paid_invoice`, `paid_memberships_allow_default_tier_toggled`, `paid_memberships_default_tier_edited`, `paid_memberships_disabled`, `paid_memberships_enabled`, `paid_memberships_join_abandoned`, `paid_memberships_join_applied`, `paid_memberships_join_approval_revoked`, `paid_memberships_join_approved`, `paid_memberships_join_completed`, `paid_memberships_join_expired`, `paid_memberships_join_orphan_refunded`, `paid_memberships_join_pending_created`, `paid_memberships_join_reminder_sent`, `paid_memberships_join_withdrawn`, `paid_memberships_stripe_deauthorized`, `paid_memberships_subgroup_access_changed`, `paid_memberships_subgroup_grandfathered_removed`, `paid_memberships_subgroup_reenable_reconciled`, `paid_memberships_subgroup_removed`, `plan_change`, `post_to_sub`, `poststatus_changed`, `prevented_from_joining`, `reinvited_member`, `rejected_member`, `rejected_pending_message`, `removed_bluesky_integration`, `removed_email_integration`, `removed_facebook_integration`, `removed_github_integration`, `removed_hashtag`, `removed_instagram_integration`, `removed_invite`, `removed_member`, `removed_member_label`, `removed_rss_integration`, `removed_trello_integration`, `removed_webhook`, `reopened_thread`, `reported_file`, `reported_message`, `reported_photo`, `resent_confirmation`, `resent_pending_member_notice`, `resumed_membership`, `rotated_photo`, `sent_bounce_probe`, `sent_message_accepted`, `sent_message_announcement`, `sent_message_announcement_password`, `sent_message_attachment_bounced`, `sent_message_banned`, `sent_message_bounced_sub`, `sent_message_cant_add_event`, `sent_message_cant_create_tags`, `sent_message_closed_topic`, `sent_message_mod_only_tags`, `sent_message_moderated`, `sent_message_no_tags`, `sent_message_not_allowed`, `sent_message_not_confirmed_sub`, `sent_message_not_subscriber`, `sent_message_pending_sub`, `sent_message_too_big`, `sent_to_owner`, `sig_changed`, `sig_changed_by_moderator`, `spam_left`, `spam_sent_to_owner`, `split_thread`, `sticky_thread`, `stripe_account_connected`, `stripe_account_disconnected`, `sub_tier_id_drift_repaired`, `test_webhook`, `tier_created`, `tier_disabled`, `tier_edited`, `tier_enabled`, `tier_hard_deleted`, `tier_price_created`, `tier_price_deleted`, `tier_price_disabled`, `tier_restored`, `tier_soft_deleted`, `unbanned_member`, `unbounced_user`, `unlocked_event`, `unmoderated_thread`, `unsticky_thread`, `virus_bounced_member`, `virus_bounced_nonmember`, `virus_moderated_message`.
member_info Member Info object

Example Object

{
   "action": "spamleft",
   "created": "2009-11-10T15:00:00-08:00",
   "id": 19,
   "member_info": {
     "id": 93846546,
     "object": "member_info",
     "created": "2020-09-09T04:11:00-07:00",
     "updated": "2022-06-08T07:16:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "group_name": "StrategyHub",
     "status": "sub_status_normal",
     "post_status": "sub_poststatus_newusermoderated",
     "email_delivery": "email_delivery_digest",
     "message_selection": "message_selection_follow_and_first_message",
     "auto_follow_replies": false,
     "max_attachment_size": "max_attachment_size_medium",
     "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "profile_privacy": "profile_private",
     "dont_munge_message_id": false,
     "use_signature": false,
     "use_signature_email": false,
     "signature": "In hotel furniture anyone weakly besides",
     "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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "member_labels": [
       {
         "id": 726,
         "object": "memberlabel",
         "created": "2020-09-29T22:19:00Z",
         "group_id": 1857,
         "name": "Florida",
         "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
         "color_name": "green-sage",
         "color_hex": "#9fc4ac"
       },
       {
         "id": 1594,
         "object": "memberlabel",
         "created": "2020-09-24T02:24:00Z",
         "group_id": 42,
         "name": "Russel",
         "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
         "color_name": "purple",
         "color_hex": "#837fd5"
       },
       {
         "id": 1189,
         "object": "memberlabel",
         "created": "2020-09-12T02:11:00Z",
         "group_id": 1474,
         "name": "Meta",
         "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
         "color_name": "sky",
         "color_hex": "#9cc7df"
       }
     ],
     "extra_member_data": [
       {
         "col_id": 48876437,
         "col_type": "text_column",
         "text": "To firstly unlock while host himself me purely as whose."
       },
       {
         "col_id": 161476183,
         "col_type": "paragraph_column",
         "text": "Yet few mustering example will addition yearly since in these."
       },
       {
         "col_id": 39354277,
         "col_type": "checkbox_column",
         "checked": false
       },
       {
         "col_id": 8897324,
         "col_type": "multiple_choice_column",
         "multi_choice": [
           0
         ]
       },
       {
         "col_id": 159828550,
         "col_type": "date_column",
         "date": "1923-10-16T17:57:55.797000001Z"
       },
       {
         "col_id": 185149472,
         "col_type": "time_column",
         "time": "1929-03-30T18:00:36.790929649Z"
       },
       {
         "col_id": 166814414,
         "col_type": "address_column",
         "street_address1": "Premier Medical Group",
         "street_address2": "3701 DAUPHIN ST",
         "city": "MOBILE",
         "state": "AL",
         "zip": "36608-1756",
         "lat": 30.6866076,
         "lng": -88.13019249999999
       },
       {
         "col_id": 102385421,
         "col_type": "multi_choice_column",
         "multi_choice": [
           0,
           1,
           2
         ]
       },
       {
         "col_id": 154317202,
         "col_type": "link_column",
         "title": "To say poorly out according abundant unless nervously string lastly.",
         "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
         "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
       },
       {
         "col_id": 123191768,
         "col_type": "image_column",
         "url": "https://picsum.photos/id/27/187/110",
         "image_name": "Lately blazer with wild hourly there she it infrequently power."
       },
       {
         "col_id": 53386358,
         "col_type": "html_paragraph_column",
         "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
       },
       {
         "col_id": 45812071,
         "col_type": "email_column",
         "text": "brantkozey@bernhard.com"
       }
     ]
   },
   "object": "past_member"
}

The Past Member List Object#

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

Response Attributes

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

Methods That Use This Object

Get Past Members	View Method

Example Object

{
   "data": [
     {
       "action": "spamleft",
       "created": "2009-11-10T15:00:00-08:00",
       "id": 24,
       "member_info": {
         "id": 93846546,
         "object": "member_info",
         "created": "2020-09-09T04:11:00-07:00",
         "updated": "2022-06-08T07:16:00-07:00",
         "user_id": 147779411,
         "group_id": 8658933,
         "group_name": "StrategyHub",
         "status": "sub_status_normal",
         "post_status": "sub_poststatus_newusermoderated",
         "email_delivery": "email_delivery_digest",
         "message_selection": "message_selection_follow_and_first_message",
         "auto_follow_replies": false,
         "max_attachment_size": "max_attachment_size_medium",
         "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "profile_privacy": "profile_private",
         "dont_munge_message_id": false,
         "use_signature": false,
         "use_signature_email": false,
         "signature": "In hotel furniture anyone weakly besides",
         "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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "member_labels": [
           {
             "id": 726,
             "object": "memberlabel",
             "created": "2020-09-29T22:19:00Z",
             "group_id": 1857,
             "name": "Florida",
             "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
             "color_name": "green-sage",
             "color_hex": "#9fc4ac"
           },
           {
             "id": 1594,
             "object": "memberlabel",
             "created": "2020-09-24T02:24:00Z",
             "group_id": 42,
             "name": "Russel",
             "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
             "color_name": "purple",
             "color_hex": "#837fd5"
           },
           {
             "id": 1189,
             "object": "memberlabel",
             "created": "2020-09-12T02:11:00Z",
             "group_id": 1474,
             "name": "Meta",
             "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
             "color_name": "sky",
             "color_hex": "#9cc7df"
           }
         ],
         "extra_member_data": [
           {
             "col_id": 48876437,
             "col_type": "text_column",
             "text": "To firstly unlock while host himself me purely as whose."
           },
           {
             "col_id": 161476183,
             "col_type": "paragraph_column",
             "text": "Yet few mustering example will addition yearly since in these."
           },
           {
             "col_id": 39354277,
             "col_type": "checkbox_column",
             "checked": false
           },
           {
             "col_id": 8897324,
             "col_type": "multiple_choice_column",
             "multi_choice": [
               0
             ]
           },
           {
             "col_id": 159828550,
             "col_type": "date_column",
             "date": "1923-10-16T17:57:55.797000001Z"
           },
           {
             "col_id": 185149472,
             "col_type": "time_column",
             "time": "1929-03-30T18:00:36.790929649Z"
           },
           {
             "col_id": 166814414,
             "col_type": "address_column",
             "street_address1": "Premier Medical Group",
             "street_address2": "3701 DAUPHIN ST",
             "city": "MOBILE",
             "state": "AL",
             "zip": "36608-1756",
             "lat": 30.6866076,
             "lng": -88.13019249999999
           },
           {
             "col_id": 102385421,
             "col_type": "multi_choice_column",
             "multi_choice": [
               0,
               1,
               2
             ]
           },
           {
             "col_id": 154317202,
             "col_type": "link_column",
             "title": "To say poorly out according abundant unless nervously string lastly.",
             "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
             "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
           },
           {
             "col_id": 123191768,
             "col_type": "image_column",
             "url": "https://picsum.photos/id/27/187/110",
             "image_name": "Lately blazer with wild hourly there she it infrequently power."
           },
           {
             "col_id": 53386358,
             "col_type": "html_paragraph_column",
             "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
           },
           {
             "col_id": 45812071,
             "col_type": "email_column",
             "text": "brantkozey@bernhard.com"
           }
         ]
       },
       "object": "past_member"
     }
   ],
   "end_item": 93,
   "has_more": false,
   "next_page_token": 0,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 18,
   "total_count": 38
}

The Pending Message Object#

The pending message object.

Response Attributes

object string	pending_message.
id integer	ID of the pending message object, referenced in results.
created string date-time	Time pending message was received.
updated string date-time	Time of last update to the pending message.
group_id integer	ID of the group.
user_id integer	ID of the user.
subject string	Message subject.
is_special boolean	True if this is a special message.
is_web_post boolean	If the message was posted from the web.
has_attachments boolean	True if the message has attachments.
editor_member_id integer	Member ID of the person who edited this message if this is an edit.
raw_message string	The message body, in HTML format.
message_body string	Decoded message body.
body_format string	Message body format.
sender optional Profile Data object	Subscriber who sent the message, may be excluded if a non-subscriber.
sender_email string	Email of the sender, use if sender is not available.
sender_name string	Name of the sender, use if sender is not available.
claiming_user optional Profile Data object	Moderator who has claimed the message.
claimed_date string date-time	When the moderator claimed the message.
editor optional Profile Data object	Moderator who has edited the message, may be excluded if the message hasn't been edited.
edit_reason string	The reason given by the editor for the edit.
type string	Pending message type.
virus_name string	If this message is moderated because of a virus, this is the name of the virus.

Example Object

{
   "body_format": "",
   "claimed_date": "2009-11-10T15:00:00-08:00",
   "claiming_user": {
     "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "name": "Lawson Kreiger",
     "can_view_profile": false
   },
   "created": "2009-11-10T15:00:00-08:00",
   "edit_reason": "",
   "editor": {
     "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "name": "Lawson Kreiger",
     "can_view_profile": false
   },
   "editor_member_id": 87,
   "group_id": 57,
   "has_attachments": false,
   "id": 33,
   "is_special": false,
   "is_web_post": false,
   "message_body": "",
   "object": "pending_message",
   "raw_message": "",
   "sender": {
     "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "name": "Lawson Kreiger",
     "can_view_profile": false
   },
   "sender_email": "",
   "sender_name": "",
   "subject": "",
   "type": "",
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 66,
   "virus_name": ""
}

The Pending Message List Object#

Pending Message List

Response Attributes

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

Methods That Use This Object

Get Pending Messages	View Method

Example Object

{
   "data": [
     {
       "body_format": "",
       "claimed_date": "2009-11-10T15:00:00-08:00",
       "claiming_user": {
         "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "name": "Lawson Kreiger",
         "can_view_profile": false
       },
       "created": "2009-11-10T15:00:00-08:00",
       "edit_reason": "",
       "editor": {
         "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "name": "Lawson Kreiger",
         "can_view_profile": false
       },
       "editor_member_id": 4,
       "group_id": 44,
       "has_attachments": false,
       "id": 87,
       "is_special": false,
       "is_web_post": false,
       "message_body": "",
       "object": "pending_message",
       "raw_message": "",
       "sender": {
         "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
         "name": "Lawson Kreiger",
         "can_view_profile": false
       },
       "sender_email": "",
       "sender_name": "",
       "subject": "",
       "type": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 37,
       "virus_name": ""
     }
   ],
   "end_item": 5,
   "has_more": false,
   "next_page_token": 21,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 95,
   "total_count": 90
}

The Pending Message Result Object#

Pending Message Result

Response Attributes

id integer	ID of the pending message.
result string	Result of the operation on this message.

Example Object

{
   "id": 95,
   "result": ""
}

The Pending Message Results List Object#

Pending Message Results List

Response Attributes

data array of Pending Message Result objects nullable

Example Object

{
   "data": [
     {
       "id": 22,
       "result": ""
     }
   ]
}

The Perms Object#

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

Response Attributes

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

Methods That Use This Object

Get Permissions	View Method

Example Object

{
   "object": "perms",
   "archives_visible": true,
   "polls_visible": true,
   "members_visible": true,
   "chat_visible": true,
   "calendar_visible": true,
   "files_visible": true,
   "database_visible": true,
   "photos_visible": true,
   "wiki_visible": true,
   "member_directory_visible": true,
   "hashtags_visible": true,
   "guidelines_visible": true,
   "subgroups_visible": true,
   "open_donations_visible": true,
   "sponsor_visible": true,
   "manage_subgroups": true,
   "ask_visible": 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_reply": 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,
   "can_ask": true
}

The Photo Object#

The photo object.

Response Attributes

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

Methods That Use This Object

Get Photo	View Method

Example Object

{
   "id": 960,
   "object": "photo",
   "created": "2020-09-06T23:48:00-07:00",
   "updated": "2022-03-08T08:06:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "name": "Elegance joy group",
   "desc": "Senegalese whichever happen trade move outside downstairs of exemplified up. Out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for. Her our much nevertheless which numerous alone bevy as by. From e.g. otherwise laptop cloud then them yourselves few look.",
   "media_type": "image/jpg",
   "size": 2390440,
   "attachment_num": 0,
   "width": 0,
   "height": 0,
   "album_id": 52691321,
   "display_name": "Lawson Kreiger",
   "user_name": "Dickens6041",
   "profile_privacy": "profile_private",
   "email": "gersonbeahan@...",
   "format": "jpeg",
   "focal_length": 0,
   "iso": 0,
   "aperture": 0,
   "shutter_speed": 0,
   "taken": 0,
   "make": "",
   "model": ""
}

The Photo List Object#

Photo List

Response Attributes

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

Methods That Use This Object

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

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 1253,
       "object": "photo",
       "created": "2020-08-30T23:30:00-07:00",
       "updated": "2023-04-23T17:44:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Store elegance joy group Senegalese",
       "desc": "Whichever happen trade move outside downstairs of exemplified up out. Destroy due taste anything where this that would whom to. Cautiously till only himself fight our whomever that for her. Our much nevertheless which numerous alone bevy as by from. E.g. otherwise laptop cloud then them yourselves few look fleet.",
       "media_type": "image/jpg",
       "size": 9234415,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 52691321,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 777,
       "object": "photo",
       "created": "2020-09-23T03:05:00-07:00",
       "updated": "2022-11-16T21:00:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "As yesterday we inquire",
       "desc": "Ourselves his laugh string several accordingly kindness bit stand woman. Just poised they enough thing homework each clothing other cry. Obediently refill do differs yearly those woman pen today as. Now ourselves first for without what might any where as. Out me were Norwegian significant his do mob notice lastly.",
       "media_type": "image/jpg",
       "size": 5695695,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 127437101,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     },
     {
       "id": 1620,
       "object": "photo",
       "created": "2020-09-26T00:12:00-07:00",
       "updated": "2023-03-26T20:23:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "name": "Then result these preen numerous on",
       "desc": "Frequently him at tonight is seriously why kiss logic beyond. Him swing our Amazonian will for myself everybody I abundant. Few weekly anyone an weekly someone being that her enthusiasm. Yours never without theirs mine that delay that the air. Whatever bundle you is such batch accommodation without now in.",
       "media_type": "image/jpg",
       "size": 8923756,
       "attachment_num": 0,
       "width": 0,
       "height": 0,
       "album_id": 7850581,
       "display_name": "Lawson Kreiger",
       "user_name": "Dickens6041",
       "profile_privacy": "profile_private",
       "email": "gersonbeahan@...",
       "format": "jpeg",
       "focal_length": 0,
       "iso": 0,
       "aperture": 0,
       "shutter_speed": 0,
       "taken": 0,
       "make": "",
       "model": ""
     }
   ]
}

The Poll Object#

The poll object.

Response Attributes

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

Methods That Use This Object

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

Example Object

{
   "anonymous": false,
   "answers": [
     {
       "answer": "",
       "selected": false
     }
   ],
   "can_view_profile": false,
   "can_view_results": false,
   "created": "2009-11-10T15:00:00-08:00",
   "desc": "",
   "group_id": 91,
   "id": 66,
   "is_closed": false,
   "msg_num": 99,
   "multiple": false,
   "name": "",
   "never_show_results": false,
   "object": "poll",
   "profile_photo_url": "",
   "question": "",
   "results": [
     {
       "answer": "",
       "count": 70,
       "percentage": "",
       "votes": [
         {
           "can_view_profile": false,
           "email": "",
           "name": "",
           "profile_photo_url": "",
           "user_id": 52
         }
       ]
     }
   ],
   "results_at_end": false,
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 87
}

The Poll Answer Object#

The poll answer object.

Response Attributes

answer string	Possible answer.
selected boolean	If we selected this answer.

Example Object

{
   "answer": "",
   "selected": false
}

The Poll Result Object#

The poll result object.

Response Attributes

answer string	The answer.
count integer	How many people voted for this answer.
percentage string	The percentage of total votes for this answer.
votes optional array of Poll Vote objects	All votes for this answer, if we have permission to view them.

Example Object

{
   "answer": "",
   "count": 10,
   "percentage": "",
   "votes": [
     {
       "can_view_profile": false,
       "email": "",
       "name": "",
       "profile_photo_url": "",
       "user_id": 85
     }
   ]
}

The Poll Results Object#

The poll results object.

Response Attributes

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

Methods That Use This Object

Get Poll Results	View Method

Example Object

{
   "object": "poll_results",
   "poll_id": 13,
   "results": [
     {
       "answer": "",
       "count": 22,
       "percentage": "",
       "votes": [
         {
           "can_view_profile": false,
           "email": "",
           "name": "",
           "profile_photo_url": "",
           "user_id": 23
         }
       ]
     }
   ]
}

The Poll Vote Object#

The poll vote object. Represents a single vote in a poll.

Response Attributes

user_id integer	User ID of the voter.
email string	Email of the voter.
profile_photo_url string	If not empty then there is a profile photo associated with this votor.
name string	Name of the person who voted.
can_view_profile boolean	If the person viewing this poll can view the profile.

Example Object

{
   "can_view_profile": false,
   "email": "",
   "name": "",
   "profile_photo_url": "",
   "user_id": 34
}

The Profile Data Object#

The profile data object.

Response Attributes

profile_photo_url string	If not empty then there is a profile photo associated with this votor.
name string	Name of the person who voted.
can_view_profile boolean	If the person viewing this poll can view the profile.

Example Object

{
   "profile_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
   "name": "Lawson Kreiger",
   "can_view_profile": false
}

The Push Sub Object#

The push subscription object.

Response Attributes

id integer	Unique ID of the push sub object.
object string	push_sub.
created string date-time
updated string date-time
user_id integer	ID of the person who is subscribed.
type string	Type of push subscription. Can be one of: `mobile_push_sub`, `no_push_sub`, `web_push_sub`.
os string	Operating System associated with the push subscription.
browser string	Browser associated with the push subscription, not set if this is a device push subscription. Can be one of: `app`, `chrome`, `chromium`, `crawler`, `edge`, `firefox`, `msie`, `opera`, `safari`, `unknown_browser`.
p256dh string	for web push subs.
auth string	for web push subs.
endpoint string	for web push subs, is the token for mobile push subs.

Example Object

{
   "auth": "",
   "browser": "app",
   "created": "2009-11-10T15:00:00-08:00",
   "endpoint": "",
   "id": 16,
   "object": "push_sub",
   "os": "",
   "p256dh": "",
   "type": "mobile_push_sub",
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 96
}

The Push Sub List Object#

Push Sub List

Response Attributes

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

Methods That Use This Object

Get Push Subs	View Method

Example Object

{
   "data": [
     {
       "auth": "",
       "browser": "app",
       "created": "2009-11-10T15:00:00-08:00",
       "endpoint": "",
       "id": 71,
       "object": "push_sub",
       "os": "",
       "p256dh": "",
       "type": "mobile_push_sub",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 95
     }
   ],
   "end_item": 87,
   "has_more": false,
   "next_page_token": 58,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 97,
   "total_count": 26
}

The RSVP Object#

The rsvp object.

Response Attributes

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

Methods That Use This Object

RSVP To An Event	View Method

Example Object

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

The Remove Error Object#

A failed address in a bulk member removal.

Response Attributes

object string	remove_error.
email string
status string	Can be one of: `bulk_remove_db_error`, `bulk_remove_invalid_email`, `bulk_remove_not_a_member`, `bulk_remove_sole_group_owner`, `bulk_remove_success`.

Example Object

{
   "email": "",
   "object": "remove_error",
   "status": "bulk_remove_db_error"
}

The Sub Group And Category Object#

The sub group and category object.

Response Attributes

category Sub Group Category object
group Group object

Example Object

{
   "category": {
     "created": "2009-11-10T15:00:00-08:00",
     "desc": "",
     "id": 16,
     "max_subs": 21,
     "name": "example",
     "object": "sub_group_category",
     "order": 60,
     "parent_group_id": 26,
     "updated": "2009-11-10T15:00:00-08:00"
   },
   "group": {
     "id": 8658933,
     "object": "group",
     "created": "2020-09-15T11:29:00-07:00",
     "updated": "2022-02-12T18:51:00-08:00",
     "type": "group_type_messages",
     "title": "",
     "name": "StrategyHub",
     "nice_group_name": "",
     "alias": "",
     "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
     "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
     "subject_tag": "[StrategyHub]",
     "footer": "This is my\nFooter!!!!",
     "website": "",
     "announce": false,
     "moderation": "moderated",
     "new_users_moderated": true,
     "unmoderate_users_after": 3,
     "restricted": true,
     "invite_only": false,
     "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_by_members",
     "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,
     "two_factor_policy": "group_2fa_policy_none",
     "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,
     "ai_summaries_enabled": false,
     "sticky_wiki_page_id": 0,
     "sub_group_categoryid": 0,
     "subs_count": 541,
     "pending_subs_count": 0,
     "pending_msgs_count": 0,
     "open_chats_count": 0,
     "threads_count": 0,
     "messages_count": 0,
     "org_domain": "",
     "most_recent_message": "2020-09-07T19:38:00-07: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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "email_address": "StrategyHub@groups.io",
     "extra_member_data_columns": [
       {
         "id": 48876437,
         "name": "Text: Lots write point week doctor.",
         "type": "text_column",
         "required": true,
         "color": "color_beige",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Movement whose also it vanish watch these to ever always."
       },
       {
         "id": 161476183,
         "name": "Paragraph: Other few covey range window.",
         "type": "paragraph_column",
         "required": true,
         "color": "color_light_brown",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Silence lastly had what outcome let while school pause up."
       },
       {
         "id": 39354277,
         "name": "Checkbox: Company freedom pout his throw.",
         "type": "checkbox_column",
         "required": true,
         "color": "color_orange",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Quarterly outfit faithful is often part whom these been hourly."
       },
       {
         "id": 8897324,
         "name": "Multiple Choice: Madagascan anyway should late yours.",
         "type": "multiple_choice_column",
         "required": true,
         "color": "color_orchid",
         "choices": [
           "Monthly ball upon almost everything dynasty.",
           "Behalf shall nearly this weekly for.",
           "Anywhere everybody over secondly then boat."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Besides pack when murder her had snore first in limp."
       },
       {
         "id": 159828550,
         "name": "Date: Which these bale nobody few.",
         "type": "date_column",
         "required": true,
         "color": "color_blush",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "How anyone these string life that who result lately yourselves."
       },
       {
         "id": 185149472,
         "name": "Time: Besides later whom for rarely.",
         "type": "time_column",
         "required": true,
         "color": "color_sage",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Each her ski ours host our as did they to."
       },
       {
         "id": 166814414,
         "name": "Address: Bravery where this as cloud.",
         "type": "address_column",
         "required": true,
         "color": "color_cucumber",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Inside since open most you that including fight murder cautiously."
       },
       {
         "id": 102385421,
         "name": "Multi Choice: Another what full her can.",
         "type": "multi_choice_column",
         "required": true,
         "color": "color_aquamute",
         "choices": [
           "Indeed besides motherhood in that nightly.",
           "Limit we kneel herself collect yourselves.",
           "Yourselves Norwegian this fear happily fruit."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Pout nature bike moreover from whoever afterwards myself mine to."
       },
       {
         "id": 154317202,
         "name": "Link: Bale sedge Christian would whose.",
         "type": "link_column",
         "required": true,
         "color": "color_military",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Hers pack rhythm that now whose her out infancy somebody."
       },
       {
         "id": 123191768,
         "name": "Image: Today scenic consequently ours eye.",
         "type": "image_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Other other abundant some anywhere this life nevertheless in next."
       },
       {
         "id": 53386358,
         "name": "HTML Paragraph: Nobody what today e.g. loss.",
         "type": "html_paragraph_column",
         "required": true,
         "color": "color_emerald_green",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Spite Philippine before throughout wander of as there next of."
       },
       {
         "id": 45812071,
         "name": "Email: That because am terribly many.",
         "type": "email_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Because anyone does you hungrily can several might who monthly."
       }
     ]
   }
}

The Sub Group Category Object#

The sub group category object.

Response Attributes

id integer
object string	sub_group_category.
created string date-time
updated string date-time
parent_group_id integer
name string	Name.
desc string	Description, in HTML format.
max_subs integer	Max number of subscribers allowed per group.
order integer	Used in sort.

Example Object

{
   "created": "2009-11-10T15:00:00-08:00",
   "desc": "",
   "id": 45,
   "max_subs": 3,
   "name": "example",
   "object": "sub_group_category",
   "order": 91,
   "parent_group_id": 76,
   "updated": "2009-11-10T15:00:00-08:00"
}

The Sub Group Category List Object#

Sub Group Category List

Response Attributes

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

Methods That Use This Object

Get Sub Group Categories	View Method

Example Object

{
   "data": [
     {
       "created": "2009-11-10T15:00:00-08:00",
       "desc": "",
       "id": 34,
       "max_subs": 30,
       "name": "example",
       "object": "sub_group_category",
       "order": 85,
       "parent_group_id": 78,
       "updated": "2009-11-10T15:00:00-08:00"
     }
   ],
   "end_item": 75,
   "has_more": false,
   "next_page_token": 22,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 18,
   "total_count": 68
}

The Sub Groups By Category Object#

The sub groups by categories object.

Response Attributes

subscribed array of Sub Group And Category objects nullable	Subgroups you are subscribed to.
uncategorized array of Group objects nullable	Uncategorized subgroups you are not subscribed to.
by_category array of Sub Group And Category objects nullable	Categorized subgroups you are not subscribed to.

Methods That Use This Object

Get Sub Groups By Category	View Method

Example Object

{
   "by_category": [
     {
       "category": {
         "created": "2009-11-10T15:00:00-08:00",
         "desc": "",
         "id": 97,
         "max_subs": 71,
         "name": "example",
         "object": "sub_group_category",
         "order": 27,
         "parent_group_id": 95,
         "updated": "2009-11-10T15:00:00-08:00"
       },
       "group": {
         "id": 8658933,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "StrategyHub",
         "nice_group_name": "",
         "alias": "",
         "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
         "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
         "subject_tag": "[StrategyHub]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "invite_only": false,
         "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_by_members",
         "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,
         "two_factor_policy": "group_2fa_policy_none",
         "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,
         "ai_summaries_enabled": false,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 541,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "2020-09-07T19:38:00-07: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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "email_address": "StrategyHub@groups.io",
         "extra_member_data_columns": [
           {
             "id": 48876437,
             "name": "Text: Lots write point week doctor.",
             "type": "text_column",
             "required": true,
             "color": "color_beige",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Movement whose also it vanish watch these to ever always."
           },
           {
             "id": 161476183,
             "name": "Paragraph: Other few covey range window.",
             "type": "paragraph_column",
             "required": true,
             "color": "color_light_brown",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Silence lastly had what outcome let while school pause up."
           },
           {
             "id": 39354277,
             "name": "Checkbox: Company freedom pout his throw.",
             "type": "checkbox_column",
             "required": true,
             "color": "color_orange",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Quarterly outfit faithful is often part whom these been hourly."
           },
           {
             "id": 8897324,
             "name": "Multiple Choice: Madagascan anyway should late yours.",
             "type": "multiple_choice_column",
             "required": true,
             "color": "color_orchid",
             "choices": [
               "Monthly ball upon almost everything dynasty.",
               "Behalf shall nearly this weekly for.",
               "Anywhere everybody over secondly then boat."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Besides pack when murder her had snore first in limp."
           },
           {
             "id": 159828550,
             "name": "Date: Which these bale nobody few.",
             "type": "date_column",
             "required": true,
             "color": "color_blush",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "How anyone these string life that who result lately yourselves."
           },
           {
             "id": 185149472,
             "name": "Time: Besides later whom for rarely.",
             "type": "time_column",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Each her ski ours host our as did they to."
           },
           {
             "id": 166814414,
             "name": "Address: Bravery where this as cloud.",
             "type": "address_column",
             "required": true,
             "color": "color_cucumber",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Inside since open most you that including fight murder cautiously."
           },
           {
             "id": 102385421,
             "name": "Multi Choice: Another what full her can.",
             "type": "multi_choice_column",
             "required": true,
             "color": "color_aquamute",
             "choices": [
               "Indeed besides motherhood in that nightly.",
               "Limit we kneel herself collect yourselves.",
               "Yourselves Norwegian this fear happily fruit."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pout nature bike moreover from whoever afterwards myself mine to."
           },
           {
             "id": 154317202,
             "name": "Link: Bale sedge Christian would whose.",
             "type": "link_column",
             "required": true,
             "color": "color_military",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Hers pack rhythm that now whose her out infancy somebody."
           },
           {
             "id": 123191768,
             "name": "Image: Today scenic consequently ours eye.",
             "type": "image_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Other other abundant some anywhere this life nevertheless in next."
           },
           {
             "id": 53386358,
             "name": "HTML Paragraph: Nobody what today e.g. loss.",
             "type": "html_paragraph_column",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Spite Philippine before throughout wander of as there next of."
           },
           {
             "id": 45812071,
             "name": "Email: That because am terribly many.",
             "type": "email_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Because anyone does you hungrily can several might who monthly."
           }
         ]
       }
     }
   ],
   "subscribed": [
     {
       "category": {
         "created": "2009-11-10T15:00:00-08:00",
         "desc": "",
         "id": 48,
         "max_subs": 32,
         "name": "example",
         "object": "sub_group_category",
         "order": 81,
         "parent_group_id": 24,
         "updated": "2009-11-10T15:00:00-08:00"
       },
       "group": {
         "id": 8658933,
         "object": "group",
         "created": "2020-09-15T11:29:00-07:00",
         "updated": "2022-02-12T18:51:00-08:00",
         "type": "group_type_messages",
         "title": "",
         "name": "StrategyHub",
         "nice_group_name": "",
         "alias": "",
         "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
         "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
         "subject_tag": "[StrategyHub]",
         "footer": "This is my\nFooter!!!!",
         "website": "",
         "announce": false,
         "moderation": "moderated",
         "new_users_moderated": true,
         "unmoderate_users_after": 3,
         "restricted": true,
         "invite_only": false,
         "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_by_members",
         "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,
         "two_factor_policy": "group_2fa_policy_none",
         "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,
         "ai_summaries_enabled": false,
         "sticky_wiki_page_id": 0,
         "sub_group_categoryid": 0,
         "subs_count": 541,
         "pending_subs_count": 0,
         "pending_msgs_count": 0,
         "open_chats_count": 0,
         "threads_count": 0,
         "messages_count": 0,
         "org_domain": "",
         "most_recent_message": "2020-09-07T19:38:00-07: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,
           "ask_visible": 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_reply": 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,
           "can_ask": true
         },
         "email_address": "StrategyHub@groups.io",
         "extra_member_data_columns": [
           {
             "id": 48876437,
             "name": "Text: Lots write point week doctor.",
             "type": "text_column",
             "required": true,
             "color": "color_beige",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Movement whose also it vanish watch these to ever always."
           },
           {
             "id": 161476183,
             "name": "Paragraph: Other few covey range window.",
             "type": "paragraph_column",
             "required": true,
             "color": "color_light_brown",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Silence lastly had what outcome let while school pause up."
           },
           {
             "id": 39354277,
             "name": "Checkbox: Company freedom pout his throw.",
             "type": "checkbox_column",
             "required": true,
             "color": "color_orange",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Quarterly outfit faithful is often part whom these been hourly."
           },
           {
             "id": 8897324,
             "name": "Multiple Choice: Madagascan anyway should late yours.",
             "type": "multiple_choice_column",
             "required": true,
             "color": "color_orchid",
             "choices": [
               "Monthly ball upon almost everything dynasty.",
               "Behalf shall nearly this weekly for.",
               "Anywhere everybody over secondly then boat."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Besides pack when murder her had snore first in limp."
           },
           {
             "id": 159828550,
             "name": "Date: Which these bale nobody few.",
             "type": "date_column",
             "required": true,
             "color": "color_blush",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "How anyone these string life that who result lately yourselves."
           },
           {
             "id": 185149472,
             "name": "Time: Besides later whom for rarely.",
             "type": "time_column",
             "required": true,
             "color": "color_sage",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Each her ski ours host our as did they to."
           },
           {
             "id": 166814414,
             "name": "Address: Bravery where this as cloud.",
             "type": "address_column",
             "required": true,
             "color": "color_cucumber",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Inside since open most you that including fight murder cautiously."
           },
           {
             "id": 102385421,
             "name": "Multi Choice: Another what full her can.",
             "type": "multi_choice_column",
             "required": true,
             "color": "color_aquamute",
             "choices": [
               "Indeed besides motherhood in that nightly.",
               "Limit we kneel herself collect yourselves.",
               "Yourselves Norwegian this fear happily fruit."
             ],
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Pout nature bike moreover from whoever afterwards myself mine to."
           },
           {
             "id": 154317202,
             "name": "Link: Bale sedge Christian would whose.",
             "type": "link_column",
             "required": true,
             "color": "color_military",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Hers pack rhythm that now whose her out infancy somebody."
           },
           {
             "id": 123191768,
             "name": "Image: Today scenic consequently ours eye.",
             "type": "image_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Other other abundant some anywhere this life nevertheless in next."
           },
           {
             "id": 53386358,
             "name": "HTML Paragraph: Nobody what today e.g. loss.",
             "type": "html_paragraph_column",
             "required": true,
             "color": "color_emerald_green",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Spite Philippine before throughout wander of as there next of."
           },
           {
             "id": 45812071,
             "name": "Email: That because am terribly many.",
             "type": "email_column",
             "required": true,
             "color": "color_light_grey",
             "width": 0,
             "default_hidden": false,
             "profile": false,
             "description": "Because anyone does you hungrily can several might who monthly."
           }
         ]
       }
     }
   ],
   "uncategorized": [
     {
       "id": 8658933,
       "object": "group",
       "created": "2020-09-15T11:29:00-07:00",
       "updated": "2022-02-12T18:51:00-08:00",
       "type": "group_type_messages",
       "title": "",
       "name": "StrategyHub",
       "nice_group_name": "",
       "alias": "",
       "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
       "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
       "subject_tag": "[StrategyHub]",
       "footer": "This is my\nFooter!!!!",
       "website": "",
       "announce": false,
       "moderation": "moderated",
       "new_users_moderated": true,
       "unmoderate_users_after": 3,
       "restricted": true,
       "invite_only": false,
       "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_by_members",
       "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,
       "two_factor_policy": "group_2fa_policy_none",
       "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,
       "ai_summaries_enabled": false,
       "sticky_wiki_page_id": 0,
       "sub_group_categoryid": 0,
       "subs_count": 541,
       "pending_subs_count": 0,
       "pending_msgs_count": 0,
       "open_chats_count": 0,
       "threads_count": 0,
       "messages_count": 0,
       "org_domain": "",
       "most_recent_message": "2020-09-07T19:38:00-07: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,
         "ask_visible": 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_reply": 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,
         "can_ask": true
       },
       "email_address": "StrategyHub@groups.io",
       "extra_member_data_columns": [
         {
           "id": 48876437,
           "name": "Text: Lots write point week doctor.",
           "type": "text_column",
           "required": true,
           "color": "color_beige",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Movement whose also it vanish watch these to ever always."
         },
         {
           "id": 161476183,
           "name": "Paragraph: Other few covey range window.",
           "type": "paragraph_column",
           "required": true,
           "color": "color_light_brown",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Silence lastly had what outcome let while school pause up."
         },
         {
           "id": 39354277,
           "name": "Checkbox: Company freedom pout his throw.",
           "type": "checkbox_column",
           "required": true,
           "color": "color_orange",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Quarterly outfit faithful is often part whom these been hourly."
         },
         {
           "id": 8897324,
           "name": "Multiple Choice: Madagascan anyway should late yours.",
           "type": "multiple_choice_column",
           "required": true,
           "color": "color_orchid",
           "choices": [
             "Monthly ball upon almost everything dynasty.",
             "Behalf shall nearly this weekly for.",
             "Anywhere everybody over secondly then boat."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Besides pack when murder her had snore first in limp."
         },
         {
           "id": 159828550,
           "name": "Date: Which these bale nobody few.",
           "type": "date_column",
           "required": true,
           "color": "color_blush",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "How anyone these string life that who result lately yourselves."
         },
         {
           "id": 185149472,
           "name": "Time: Besides later whom for rarely.",
           "type": "time_column",
           "required": true,
           "color": "color_sage",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Each her ski ours host our as did they to."
         },
         {
           "id": 166814414,
           "name": "Address: Bravery where this as cloud.",
           "type": "address_column",
           "required": true,
           "color": "color_cucumber",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Inside since open most you that including fight murder cautiously."
         },
         {
           "id": 102385421,
           "name": "Multi Choice: Another what full her can.",
           "type": "multi_choice_column",
           "required": true,
           "color": "color_aquamute",
           "choices": [
             "Indeed besides motherhood in that nightly.",
             "Limit we kneel herself collect yourselves.",
             "Yourselves Norwegian this fear happily fruit."
           ],
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Pout nature bike moreover from whoever afterwards myself mine to."
         },
         {
           "id": 154317202,
           "name": "Link: Bale sedge Christian would whose.",
           "type": "link_column",
           "required": true,
           "color": "color_military",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Hers pack rhythm that now whose her out infancy somebody."
         },
         {
           "id": 123191768,
           "name": "Image: Today scenic consequently ours eye.",
           "type": "image_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Other other abundant some anywhere this life nevertheless in next."
         },
         {
           "id": 53386358,
           "name": "HTML Paragraph: Nobody what today e.g. loss.",
           "type": "html_paragraph_column",
           "required": true,
           "color": "color_emerald_green",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Spite Philippine before throughout wander of as there next of."
         },
         {
           "id": 45812071,
           "name": "Email: That because am terribly many.",
           "type": "email_column",
           "required": true,
           "color": "color_light_grey",
           "width": 0,
           "default_hidden": false,
           "profile": false,
           "description": "Because anyone does you hungrily can several might who monthly."
         }
       ]
     }
   ]
}

The Success Object#

The success object.

Response Attributes

object string	success.
extra string

Methods That Use This Object

Update Event	View Method
Delete Event	View Method
Update Repeat Event	View Method
Delete Repeat Event	View Method

Example Object

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

The Topic Object#

The topic object.

Response Attributes

id integer
object string	topic.
created string date-time
updated string date-time
group_id integer
group_subject_tag string
subject string	Subject of the topic.
summary string	Summary of the first message in the topic.
name string	Name of the originator of the topic.
profile_photo_url string	If not empty then there is a profile photo associated with this author.
num_messages integer	Number of messages in the topic.
is_sticky boolean	If the topic is sticky.
is_moderated boolean	If the topic is moderated.
is_closed boolean	If the topic is closed.
has_attachments boolean	If the topic has at least one message that has attachments.
reply_to string	Can be one of: `thread_reply_group_default`, `thread_reply_only_to_sender`, `thread_reply_to_followers_only`, `thread_reply_to_group`, `thread_reply_to_group_and_sender`, `thread_reply_to_moderators`, `thread_reply_to_sender`.
most_recent_message string date-time	Date of the most recent message in the topic.
hashtags array of Hashtag objects nullable
ai_summary optional Topic AI Summary object	AISummary is present only when this group has AI summaries enabled AND a summary has been generated for the topic. Null-omitted via omitempty so clients that don't care pay no attention.

Methods That Use This Object

Update Topic	View Method

Example Object

{
   "id": 52691321,
   "object": "topic",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "group_id": 8658933,
   "group_subject_tag": "[StrategyHub]",
   "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
   "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
   "name": "Elenor Schaefer",
   "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": "2020-09-29T17:03:00-07:00",
   "hashtags": null
}

The Topic AI Summary Object#

The AI-generated summary of a topic, returned as part of a Topic when one has been generated. Clients render this above the first message. When IsStale is true, there have been new/edited/deleted messages since generation and members see a "Refresh" affordance. Non-members see the summary as-is.

Response Attributes

tldr string	1-2 sentence overall summary.
key_points array of string nullable	Bullet points expanding on the TLDR.
language string	BCP-47 tag of the summary.
is_stale boolean	True when the thread changed after generation.
messages_included integer	Number of messages included at generation time.
messages_since integer	New messages since generation (>0 when stale).
generated string date-time	When this summary was produced.
provider string	"anthropic" \| "openai" \| "gemini".

Methods That Use This Object

Get Topic AI Summary	View Method

Example Object

{
   "generated": "2009-11-10T15:00:00-08:00",
   "is_stale": false,
   "key_points": [
     ""
   ],
   "language": "",
   "messages_included": 86,
   "messages_since": 57,
   "provider": "",
   "tldr": ""
}

The Topic AI Summary Status Object#

The response shape for topic-summary status polling and generation kick-off. Status is one of "none", "generating", "stale", or "ready". Existing carries the current summary (possibly stale) when present.

Response Attributes

status string
existing optional Topic AI Summary object

Methods That Use This Object

Request Topic AI Summary	View Method
Get Topic AI Summary Status	View Method

Example Object

{
   "existing": {
     "generated": "2009-11-10T15:00:00-08:00",
     "is_stale": false,
     "key_points": [
       ""
     ],
     "language": "",
     "messages_included": 23,
     "messages_since": 14,
     "provider": "",
     "tldr": ""
   },
   "status": ""
}

The Topic List Object#

Topic List

Response Attributes

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

Methods That Use This Object

Get Topics	View Method

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "topic",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "group_id": 8658933,
       "group_subject_tag": "[StrategyHub]",
       "subject": "Anyway what quickly abundant respect pyramid accordingly onto moreover whenever e.g. fear.",
       "summary": "Usually body kilometer nightly child so firstly he next each. Secondly must catch politely sleepy where i.e. inquisitively yours wisp. Regularly nice cackle ourselves heavily now this our yearly what. Few why where win most would everybody them backwards this. That provided store elegance joy group Senegalese whichever happen trade.",
       "name": "Elenor Schaefer",
       "profile_photo_url": "",
       "num_messages": 10,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "2020-09-13T23:35:00-07:00",
       "hashtags": null
     },
     {
       "id": 40360814,
       "object": "topic",
       "created": "2020-08-30T21:35:00-07:00",
       "updated": "2023-05-02T01:56:00-07:00",
       "group_id": 8658933,
       "group_subject_tag": "[StrategyHub]",
       "subject": "Some instance inquire ourselves his laugh string several accordingly kindness bit stand.",
       "summary": "Woman just poised they enough thing homework each clothing other. Cry obediently refill do differs yearly those woman pen today. As now ourselves first for without what might any where. As out me were Norwegian significant his do mob notice. Lastly theirs hotel one calm that later does point throw.",
       "name": "Albina Bernhard",
       "profile_photo_url": "",
       "num_messages": 29,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "2020-09-08T16:42:00-07:00",
       "hashtags": null
     },
     {
       "id": 135780324,
       "object": "topic",
       "created": "2020-09-24T13:22:00-07:00",
       "updated": "2022-10-24T22:40:00-07:00",
       "group_id": 8658933,
       "group_subject_tag": "[StrategyHub]",
       "subject": "For previously as of along nobody back hers numerous would our bra.",
       "summary": "Yours union Bangladeshi Bahamian now wiggle should our example eye. Woman in religion am collapse regiment in were choir troop. Speed throw year work let bunch one choir those horror. Would is so team disregard completely decidedly which exaltation decidedly. Think niche annoyance yesterday hence as him his this one.",
       "name": "Elmore Prosacco",
       "profile_photo_url": "",
       "num_messages": 29,
       "is_sticky": false,
       "is_moderated": false,
       "is_closed": false,
       "has_attachments": false,
       "reply_to": "thread_reply_group_default",
       "most_recent_message": "2020-09-15T14:17:00-07:00",
       "hashtags": null
     }
   ]
}

The User Object#

The user object.

Response Attributes

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

Methods That Use This Object

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

Example Object

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

The Webhook Event Object#

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

Response Attributes

id integer	Unique ID for this webhook event.
object string	Type of object. Is set to `webhook_event`.
created string date-time	The time this event happened.
webhook_id integer	The ID of the webhook_subscription that triggered this event.
action string	What action took place. Can be one of: `joined`, `created_subgroup`, `deleted_subgroup`.
via string	Through what means the action took place. Can be one of: `via_api`, `via_app`, `via_email`, `via_robot`, `via_slacksync`, `via_support`, `via_web`.
group optional Group object	The group related to the action.
member_info optional Member Info object	The member who did the action. May be omitted.
modded_member_info optional Member Info object	For events on members, this is the member acted upon. May be omitted.
non_member_email optional string	For events involving a non-member, this is their email address.
msg_num optional integer	For events that involve a message, this is the message number.
subject optional string	For events that involve a message, this is the subject of the message.
message optional string	For events that involve a message, specifically `edited_message`, `sent_message_accepted`, `sent_message_moderated`, this is the raw message.
extra optional string	For events that require an extra string.
extra2 optional string	For events that require a second extra string.
extra_id optional integer	For events that require an identifier.
extended_data optional string	For events that require extended data, in JSON format.

Example Object

{
   "action": "created_group",
   "created": "2009-11-10T15:00:00-08:00",
   "extended_data": "",
   "extra": "",
   "extra2": "",
   "extra_id": 92,
   "group": {
     "id": 8658933,
     "object": "group",
     "created": "2020-09-15T11:29:00-07:00",
     "updated": "2022-02-12T18:51:00-08:00",
     "type": "group_type_messages",
     "title": "",
     "name": "StrategyHub",
     "nice_group_name": "",
     "alias": "",
     "desc": "\u003cdiv\u003eEye some contrast \u003cb\u003eas\u003c/b\u003e width yourself stand are woman over. Additionally \u003cb\u003eCosta\u003c/b\u003e that be so which archipelago \u003cb\u003ewicked\u003c/b\u003e \u003cb\u003ealong\u003c/b\u003e width. Whom exaltation \u003cb\u003ehimself\u003c/b\u003e \u003cb\u003ehow\u003c/b\u003e however might ours hers \u003cb\u003eshake\u003c/b\u003e therefore. Near quite horde huge been we something honesty sing as. These down in Japanese \u003cb\u003ethey\u003c/b\u003e out \u003cb\u003eprovided\u003c/b\u003e \u003cb\u003eover\u003c/b\u003e how today.\u003c/div\u003e",
     "plain_desc": "Eye some contrast as width yourself stand are woman over. Additionally Costa that be so which archipelago wicked along width. Whom exaltation himself how however might ours hers shake therefore. Near quite horde huge been we something honesty sing as. These down in Japanese they out provided over how today.",
     "subject_tag": "[StrategyHub]",
     "footer": "This is my\nFooter!!!!",
     "website": "",
     "announce": false,
     "moderation": "moderated",
     "new_users_moderated": true,
     "unmoderate_users_after": 3,
     "restricted": true,
     "invite_only": false,
     "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_by_members",
     "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,
     "two_factor_policy": "group_2fa_policy_none",
     "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,
     "ai_summaries_enabled": false,
     "sticky_wiki_page_id": 0,
     "sub_group_categoryid": 0,
     "subs_count": 541,
     "pending_subs_count": 0,
     "pending_msgs_count": 0,
     "open_chats_count": 0,
     "threads_count": 0,
     "messages_count": 0,
     "org_domain": "",
     "most_recent_message": "2020-09-07T19:38:00-07: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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "email_address": "StrategyHub@groups.io",
     "extra_member_data_columns": [
       {
         "id": 48876437,
         "name": "Text: Lots write point week doctor.",
         "type": "text_column",
         "required": true,
         "color": "color_beige",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Movement whose also it vanish watch these to ever always."
       },
       {
         "id": 161476183,
         "name": "Paragraph: Other few covey range window.",
         "type": "paragraph_column",
         "required": true,
         "color": "color_light_brown",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Silence lastly had what outcome let while school pause up."
       },
       {
         "id": 39354277,
         "name": "Checkbox: Company freedom pout his throw.",
         "type": "checkbox_column",
         "required": true,
         "color": "color_orange",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Quarterly outfit faithful is often part whom these been hourly."
       },
       {
         "id": 8897324,
         "name": "Multiple Choice: Madagascan anyway should late yours.",
         "type": "multiple_choice_column",
         "required": true,
         "color": "color_orchid",
         "choices": [
           "Monthly ball upon almost everything dynasty.",
           "Behalf shall nearly this weekly for.",
           "Anywhere everybody over secondly then boat."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Besides pack when murder her had snore first in limp."
       },
       {
         "id": 159828550,
         "name": "Date: Which these bale nobody few.",
         "type": "date_column",
         "required": true,
         "color": "color_blush",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "How anyone these string life that who result lately yourselves."
       },
       {
         "id": 185149472,
         "name": "Time: Besides later whom for rarely.",
         "type": "time_column",
         "required": true,
         "color": "color_sage",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Each her ski ours host our as did they to."
       },
       {
         "id": 166814414,
         "name": "Address: Bravery where this as cloud.",
         "type": "address_column",
         "required": true,
         "color": "color_cucumber",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Inside since open most you that including fight murder cautiously."
       },
       {
         "id": 102385421,
         "name": "Multi Choice: Another what full her can.",
         "type": "multi_choice_column",
         "required": true,
         "color": "color_aquamute",
         "choices": [
           "Indeed besides motherhood in that nightly.",
           "Limit we kneel herself collect yourselves.",
           "Yourselves Norwegian this fear happily fruit."
         ],
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Pout nature bike moreover from whoever afterwards myself mine to."
       },
       {
         "id": 154317202,
         "name": "Link: Bale sedge Christian would whose.",
         "type": "link_column",
         "required": true,
         "color": "color_military",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Hers pack rhythm that now whose her out infancy somebody."
       },
       {
         "id": 123191768,
         "name": "Image: Today scenic consequently ours eye.",
         "type": "image_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Other other abundant some anywhere this life nevertheless in next."
       },
       {
         "id": 53386358,
         "name": "HTML Paragraph: Nobody what today e.g. loss.",
         "type": "html_paragraph_column",
         "required": true,
         "color": "color_emerald_green",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Spite Philippine before throughout wander of as there next of."
       },
       {
         "id": 45812071,
         "name": "Email: That because am terribly many.",
         "type": "email_column",
         "required": true,
         "color": "color_light_grey",
         "width": 0,
         "default_hidden": false,
         "profile": false,
         "description": "Because anyone does you hungrily can several might who monthly."
       }
     ]
   },
   "id": 38,
   "member_info": {
     "id": 93846546,
     "object": "member_info",
     "created": "2020-09-09T04:11:00-07:00",
     "updated": "2022-06-08T07:16:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "group_name": "StrategyHub",
     "status": "sub_status_normal",
     "post_status": "sub_poststatus_newusermoderated",
     "email_delivery": "email_delivery_digest",
     "message_selection": "message_selection_follow_and_first_message",
     "auto_follow_replies": false,
     "max_attachment_size": "max_attachment_size_medium",
     "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "profile_privacy": "profile_private",
     "dont_munge_message_id": false,
     "use_signature": false,
     "use_signature_email": false,
     "signature": "In hotel furniture anyone weakly besides",
     "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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "member_labels": [
       {
         "id": 726,
         "object": "memberlabel",
         "created": "2020-09-29T22:19:00Z",
         "group_id": 1857,
         "name": "Florida",
         "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
         "color_name": "green-sage",
         "color_hex": "#9fc4ac"
       },
       {
         "id": 1594,
         "object": "memberlabel",
         "created": "2020-09-24T02:24:00Z",
         "group_id": 42,
         "name": "Russel",
         "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
         "color_name": "purple",
         "color_hex": "#837fd5"
       },
       {
         "id": 1189,
         "object": "memberlabel",
         "created": "2020-09-12T02:11:00Z",
         "group_id": 1474,
         "name": "Meta",
         "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
         "color_name": "sky",
         "color_hex": "#9cc7df"
       }
     ],
     "extra_member_data": [
       {
         "col_id": 48876437,
         "col_type": "text_column",
         "text": "To firstly unlock while host himself me purely as whose."
       },
       {
         "col_id": 161476183,
         "col_type": "paragraph_column",
         "text": "Yet few mustering example will addition yearly since in these."
       },
       {
         "col_id": 39354277,
         "col_type": "checkbox_column",
         "checked": false
       },
       {
         "col_id": 8897324,
         "col_type": "multiple_choice_column",
         "multi_choice": [
           0
         ]
       },
       {
         "col_id": 159828550,
         "col_type": "date_column",
         "date": "1923-10-16T17:57:55.797000001Z"
       },
       {
         "col_id": 185149472,
         "col_type": "time_column",
         "time": "1929-03-30T18:00:36.790929649Z"
       },
       {
         "col_id": 166814414,
         "col_type": "address_column",
         "street_address1": "Premier Medical Group",
         "street_address2": "3701 DAUPHIN ST",
         "city": "MOBILE",
         "state": "AL",
         "zip": "36608-1756",
         "lat": 30.6866076,
         "lng": -88.13019249999999
       },
       {
         "col_id": 102385421,
         "col_type": "multi_choice_column",
         "multi_choice": [
           0,
           1,
           2
         ]
       },
       {
         "col_id": 154317202,
         "col_type": "link_column",
         "title": "To say poorly out according abundant unless nervously string lastly.",
         "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
         "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
       },
       {
         "col_id": 123191768,
         "col_type": "image_column",
         "url": "https://picsum.photos/id/27/187/110",
         "image_name": "Lately blazer with wild hourly there she it infrequently power."
       },
       {
         "col_id": 53386358,
         "col_type": "html_paragraph_column",
         "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
       },
       {
         "col_id": 45812071,
         "col_type": "email_column",
         "text": "brantkozey@bernhard.com"
       }
     ]
   },
   "message": "",
   "modded_member_info": {
     "id": 93846546,
     "object": "member_info",
     "created": "2020-09-09T04:11:00-07:00",
     "updated": "2022-06-08T07:16:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "group_name": "StrategyHub",
     "status": "sub_status_normal",
     "post_status": "sub_poststatus_newusermoderated",
     "email_delivery": "email_delivery_digest",
     "message_selection": "message_selection_follow_and_first_message",
     "auto_follow_replies": false,
     "max_attachment_size": "max_attachment_size_medium",
     "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_pendingmsgs,sub_perm_pendingmembers,sub_perm_invitemembers,sub_perm_removemembers,sub_perm_banmembers,sub_perm_makemoderator,sub_perm_managehashtags,sub_perm_groupsettings,sub_perm_modsub,sub_perm_integrations,sub_perm_editarchives,sub_perm_billing,sub_perm_managesubgroups,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_photo_url": "https://s3-us-west-1.amazonaws.com/profilephoto.https://picsum.photos/id/53/498/325?AWSAccessKeyId=\u0026Expires=1788908648\u0026Signature=sKIPFI1v1FEHfkdJ2mm9LEjt6x8%3D",
     "profile_privacy": "profile_private",
     "dont_munge_message_id": false,
     "use_signature": false,
     "use_signature_email": false,
     "signature": "In hotel furniture anyone weakly besides",
     "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,
       "ask_visible": 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_reply": 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,
       "can_ask": true
     },
     "member_labels": [
       {
         "id": 726,
         "object": "memberlabel",
         "created": "2020-09-29T22:19:00Z",
         "group_id": 1857,
         "name": "Florida",
         "description": "My poor troop frequently dynasty instance dive now door she. Exemplified tomato sedge Himalayan has define bale on this library. Promise us congregation backwards most that leap ream yearly occur. Her nobody are next party little hers hers today case. Towards herself African each our food nearby e.g. understand addition.",
         "color_name": "green-sage",
         "color_hex": "#9fc4ac"
       },
       {
         "id": 1594,
         "object": "memberlabel",
         "created": "2020-09-24T02:24:00Z",
         "group_id": 42,
         "name": "Russel",
         "description": "Infrequently idea she from which what always in have it. Eventually city under sleepy shake child early garden caused as. Become lazily wheelchair by her that exaltation homeless spoon now. Its her roll another what climb crew something body then. I fortnightly on must his never research scary band at.",
         "color_name": "purple",
         "color_hex": "#837fd5"
       },
       {
         "id": 1189,
         "object": "memberlabel",
         "created": "2020-09-12T02:11:00Z",
         "group_id": 1474,
         "name": "Meta",
         "description": "Man significant British few over before addition pack my whose. This secondly that what them myself soon so extremely yourselves. Whose since shower quietly each in carry through innocence what. Him his why hers they theirs who us who of. This that above youth with fashion tonight her seldom work.",
         "color_name": "sky",
         "color_hex": "#9cc7df"
       }
     ],
     "extra_member_data": [
       {
         "col_id": 48876437,
         "col_type": "text_column",
         "text": "To firstly unlock while host himself me purely as whose."
       },
       {
         "col_id": 161476183,
         "col_type": "paragraph_column",
         "text": "Yet few mustering example will addition yearly since in these."
       },
       {
         "col_id": 39354277,
         "col_type": "checkbox_column",
         "checked": false
       },
       {
         "col_id": 8897324,
         "col_type": "multiple_choice_column",
         "multi_choice": [
           0
         ]
       },
       {
         "col_id": 159828550,
         "col_type": "date_column",
         "date": "1923-10-16T17:57:55.797000001Z"
       },
       {
         "col_id": 185149472,
         "col_type": "time_column",
         "time": "1929-03-30T18:00:36.790929649Z"
       },
       {
         "col_id": 166814414,
         "col_type": "address_column",
         "street_address1": "Premier Medical Group",
         "street_address2": "3701 DAUPHIN ST",
         "city": "MOBILE",
         "state": "AL",
         "zip": "36608-1756",
         "lat": 30.6866076,
         "lng": -88.13019249999999
       },
       {
         "col_id": 102385421,
         "col_type": "multi_choice_column",
         "multi_choice": [
           0,
           1,
           2
         ]
       },
       {
         "col_id": 154317202,
         "col_type": "link_column",
         "title": "To say poorly out according abundant unless nervously string lastly.",
         "url": "https://www.leade-tailers.biz/facilitate/facilitate/impactful/deliver",
         "desc": "Advertising faithfully it later depend deeply everybody rhythm for had."
       },
       {
         "col_id": 123191768,
         "col_type": "image_column",
         "url": "https://picsum.photos/id/27/187/110",
         "image_name": "Lately blazer with wild hourly there she it infrequently power."
       },
       {
         "col_id": 53386358,
         "col_type": "html_paragraph_column",
         "html_text": "\u003cdiv\u003eTonight \u003cb\u003eseveral\u003c/b\u003e \u003cb\u003eits\u003c/b\u003e \u003cb\u003ewhich\u003c/b\u003e \u003cb\u003esince\u003c/b\u003e \u003cb\u003etomorrow\u003c/b\u003e tonight your bag yourself our \u003cb\u003ehis\u003c/b\u003e which be \u003cb\u003eitself\u003c/b\u003e \u003cb\u003emine\u003c/b\u003e \u003cb\u003ethis\u003c/b\u003e \u003cb\u003eyesterday\u003c/b\u003e I smell.\u003c/div\u003e"
       },
       {
         "col_id": 45812071,
         "col_type": "email_column",
         "text": "brantkozey@bernhard.com"
       }
     ]
   },
   "msg_num": 31,
   "non_member_email": "",
   "object": "webhook_event",
   "subject": "",
   "via": "via_web",
   "webhook_id": 54
}

The Webhook Subscription Object#

The webhook subscription object.

Response Attributes

id integer	Unique ID of the webhook subscription.
object string	Type of object. Is set to `webhook_subscription`.
created string date-time	The time this subscription was created.
updated string date-time	The last time this subscription was updated.
url string	The URL we are to POST `webhook_event` objects to.
secret string	If specified, `webhook_events` will include a X-Groupsio-Signature header, which is an HMAC hex digest using the sha256 hash function and the `secret` as the HMAC key.
group_id integer	The group monitored by this subscription.
include_subgroups boolean	If monitoring a group, whether to monitor subgroups as well.
actions array of string nullable	The list of actions monitored by this subscription. If empty, all actions are monitored.

Methods That Use This Object

New Webhook	View Method
Update Webhook	View Method

Example Object

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

The Webhook Subscription List Object#

The webhook subscription list object.

Response Attributes

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

Methods That Use This Object

Get Webhooks	View Method

Example Object

{
   "data": [
     {
       "actions": [
         "created_subgroup"
       ],
       "created": "2009-11-10T15:00:00-08:00",
       "group_id": 21,
       "id": 65,
       "include_subgroups": false,
       "object": "webhook_subscription",
       "secret": "blahblahblah",
       "updated": "2009-11-10T15:00:00-08:00",
       "url": "https://example.com/webhook"
     }
   ],
   "end_item": 87,
   "has_more": false,
   "next_page_token": 32,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 24,
   "total_count": 51
}

The Webhook Test Result Object#

The webhook test result object. Describes the outcome of a single synchronous test delivery to a webhook subscription's URL.

Response Attributes

object string	Type of object. Is set to `webhook_test_result`.
success boolean	Whether the receiver responded with a 2xx status code.
status_code integer	The HTTP status code returned by the receiver. Is 0 if the request could not be completed.
error optional string	If the request could not be completed, the reason why.

Methods That Use This Object

Test Webhook	View Method

Example Object

{
   "error": "",
   "object": "webhook_test_result",
   "status_code": 47,
   "success": false
}

The Wiki Data Object#

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

Response Attributes

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

Example Object

{
   "id": 189165006,
   "object": "wiki_data",
   "created": "2020-09-14T08:42:00-07:00",
   "updated": "2022-07-09T08:28:00-07:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "page_id": 52691321,
   "body": "Any it such so annually myself cloud these Lebanese Guyanese you herself. Greatly one being nest when itself yet unless outfit were anybody these. It envy sit too consequently which egg lastly correctly is hand early. You moreover seed those someone daily to them backwards this that provided. Store elegance joy group Senegalese whichever happen trade move outside downstairs of.\u003cbr/\u003eExemplified up out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for her our. Much nevertheless which numerous alone bevy as by from e.g. otherwise laptop. Cloud then them yourselves few look fleet say still patrol finally Vietnamese. Painting otherwise its to a e.g. congregation cackle themselves previously in for.\u003cbr/\u003eTheirs they my there road disappear accordingly hotel so today by over. Have this Romanian abroad around while belong ever into each whatever fortnightly. He agreeable sari anyone therefore does could exaltation of sit everyone they. Had mustering would as yesterday we inquire ourselves his laugh string several. Accordingly kindness bit stand woman just poised they enough thing homework each.",
   "edit_msg": "Clothing other cry"
}

The Wiki Page Object#

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

Response Attributes

id integer
object string	wiki_page.
created string date-time
updated string date-time
user_id integer
group_id integer
title string	Title of the wiki page.
path string	Path is Title converted to a wiki page path.
locked boolean
datas optional array of Wiki Data objects	The iterations of the wiki page itself.
rev_count integer	The current revision count of the wiki page.

Example Object

{
   "id": 52691321,
   "object": "wiki_page",
   "created": "2020-09-15T02:30:00-07:00",
   "updated": "2021-03-01T18:07:00-08:00",
   "user_id": 147779411,
   "group_id": 8658933,
   "title": "Including tribe anything from whose market",
   "path": "Including-tribe-anything-from-whose-market",
   "locked": false,
   "rev_count": 43
}

The Wiki Page List Object#

Wiki Page List

Response Attributes

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

Methods That Use This Object

Get Wiki Pages	View Method

Example Object

{
   "object": "list",
   "total_count": 14,
   "start_item": 4,
   "end_item": 590,
   "has_more": true,
   "next_page_token": 1602,
   "sort_field": "created",
   "second_order": "members",
   "query": "testsearch",
   "sort_dir": "asc",
   "data": [
     {
       "id": 52691321,
       "object": "wiki_page",
       "created": "2020-09-02T00:51:00-07:00",
       "updated": "2022-06-03T11:42:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "Including tribe anything from whose",
       "path": "Including-tribe-anything-from-whose",
       "locked": false,
       "rev_count": 30
     },
     {
       "id": 29743360,
       "object": "wiki_page",
       "created": "2020-10-01T09:06:00-07:00",
       "updated": "2022-06-06T16:00:00-07:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "Yourself any it such so",
       "path": "Yourself-any-it-such-so",
       "locked": false,
       "rev_count": 37
     },
     {
       "id": 83034458,
       "object": "wiki_page",
       "created": "2020-09-14T20:59:00-07:00",
       "updated": "2022-11-29T01:40:00-08:00",
       "user_id": 147779411,
       "group_id": 8658933,
       "title": "E.g. fear usually",
       "path": "E.g.-fear-usually",
       "locked": false,
       "rev_count": 1
     }
   ]
}

The Wiki Page Set Object#

Wiki Page Set

Response Attributes

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

Methods That Use This Object

New Wiki Page	View Method
Update Wiki Page	View Method
Get Wiki Page Set	View Method

Example Object

{
   "page": {
     "id": 52691321,
     "object": "wiki_page",
     "created": "2020-09-15T02:30:00-07:00",
     "updated": "2021-03-01T18:07:00-08:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "title": "Including tribe anything from whose market",
     "path": "Including-tribe-anything-from-whose-market",
     "locked": false,
     "rev_count": 43
   },
   "data": {
     "id": 189165006,
     "object": "wiki_data",
     "created": "2020-09-14T08:42:00-07:00",
     "updated": "2022-07-09T08:28:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Any it such so annually myself cloud these Lebanese Guyanese you herself. Greatly one being nest when itself yet unless outfit were anybody these. It envy sit too consequently which egg lastly correctly is hand early. You moreover seed those someone daily to them backwards this that provided. Store elegance joy group Senegalese whichever happen trade move outside downstairs of.\u003cbr/\u003eExemplified up out destroy due taste anything where this that would whom. To cautiously till only himself fight our whomever that for her our. Much nevertheless which numerous alone bevy as by from e.g. otherwise laptop. Cloud then them yourselves few look fleet say still patrol finally Vietnamese. Painting otherwise its to a e.g. congregation cackle themselves previously in for.\u003cbr/\u003eTheirs they my there road disappear accordingly hotel so today by over. Have this Romanian abroad around while belong ever into each whatever fortnightly. He agreeable sari anyone therefore does could exaltation of sit everyone they. Had mustering would as yesterday we inquire ourselves his laugh string several. Accordingly kindness bit stand woman just poised they enough thing homework each.",
     "edit_msg": "Clothing other cry"
   },
   "sidebar": {
     "id": 126768040,
     "object": "wiki_data",
     "created": "2020-09-06T17:44:00-07:00",
     "updated": "2021-07-07T18:15:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Those line over elegantly say woman pen today as now ourselves first. For without what might any where as out me were Norwegian significant. His do mob notice lastly theirs hotel one calm that later does. Point throw neatly usually Kazakh without for one from soon swing whose. Man confusing case Bangladeshi how most somewhat several week e.g. who earlier.\u003cbr/\u003eGentle catalog ourselves then tonight bend may yearly since limit e.g. besides. Chest their hair out work data sedge this might how group out. Then result these preen numerous on frequently him at tonight is seriously. Why kiss logic beyond him swing our Amazonian will for myself everybody. I abundant few weekly anyone an weekly someone being that her enthusiasm.\u003cbr/\u003eYours never without theirs mine that delay that the air whatever bundle. You is such batch accommodation without now in yearly adventurous her for. Previously as of along nobody back hers numerous would our bra yours. Union Bangladeshi Bahamian now wiggle should our example eye woman in religion. Am collapse regiment in were choir troop speed throw year work let.",
     "edit_msg": "Bunch one choir those horror would is"
   },
   "footer": {
     "id": 9000308,
     "object": "wiki_data",
     "created": "2020-09-06T02:40:00-07:00",
     "updated": "2020-10-07T01:03:00-07:00",
     "user_id": 147779411,
     "group_id": 8658933,
     "page_id": 52691321,
     "body": "Close disregard completely decidedly which exaltation decidedly think niche annoyance yesterday hence. As him his this one into this she choir they of him. Some calm that engine our capture it that infrequently accordingly something with. Adult last often finally tonight congregation of so sneeze care massage it. Road behind recently Atlantic tea difficult were another his then afterwards finally.\u003cbr/\u003eHimself I yearly by them yet from after whom ream when fortnightly. Whose dark why besides aunt what caravan Icelandic Shakespearean theirs point spotted. Those but clap really now ourselves there rice Burmese graceful say cloud. So secondly besides moreover her sadly later several listen example answer that. Under below peacock Roman despite herself ring early outfit what are fatally.\u003cbr/\u003eRice which the door him how regularly any any key often crew. Talent it theirs disregard theirs his regularly bunch according next for French. Pretty yourselves that nutrition disregard he distinguish bones your usually as quarterly. Fondly dress pleasure ourselves my that party begin close frightening accordingly still. She outside smell hourly union anyone him leap long as had pancake.",
     "edit_msg": "Any annually gang dream without might may"
   }
}

The Wiki Search Result Object#

The topic objecsr.

Response Attributes

id integer
object string	wiki_search_result.
created string date-time
updated string date-time
user_id integer
group_id integer
data_id integer
title string	Title of the page.
rev_count integer	How many times this wiki page has been edited.
body string	Wiki page body, in HTML.
edit_msg string	Edit message for this revision, if one.
snippet string	Matching summary, in HTML.

Example Object

{
   "body": "",
   "created": "2009-11-10T15:00:00-08:00",
   "data_id": 78,
   "edit_msg": "",
   "group_id": 97,
   "id": 7,
   "object": "wiki_search_result",
   "rev_count": 49,
   "snippet": "",
   "title": "",
   "updated": "2009-11-10T15:00:00-08:00",
   "user_id": 51
}

The Wiki Search Results List Object#

Wiki Search Results List

Response Attributes

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

Methods That Use This Object

Search Wikis	View Method

Example Object

{
   "data": [
     {
       "body": "",
       "created": "2009-11-10T15:00:00-08:00",
       "data_id": 5,
       "edit_msg": "",
       "group_id": 79,
       "id": 10,
       "object": "wiki_search_result",
       "rev_count": 97,
       "snippet": "",
       "title": "",
       "updated": "2009-11-10T15:00:00-08:00",
       "user_id": 73
     }
   ],
   "end_item": 36,
   "group_id": 0,
   "has_more": false,
   "next_page_token": 63,
   "object": "list",
   "query": "",
   "second_order": "",
   "sort_dir": "",
   "sort_field": "",
   "start_item": 24,
   "total_count": 63
}

Types

Types referenced by Objects and Endpoints.

The action type#

Possible Values

accepted_invitation string	Invitation - Accepted
added_album string	Photo - Added album
added_alias string	Membership - Email alias added by member
added_banned_domain string	Banned - Domain added to banned list
added_bluesky_integration string	Integration - Added Bluesky integration
added_dir string	File - Folder added
added_email_integration string	Integration - Added email integration
added_event string	Calendar - Added event
added_facebook_integration string	Integration - Added Facebook integration
added_file string	File - Added
added_github_integration string	Integration - Added Github integration
added_group_alias string	Group - Alias added
added_group_notice string	Member Notice - Added
added_hashtag string	Hashtag - Added
added_instagram_integration string	Integration - Added Instagram integration
added_member string	Membership - Moderator direct-added new member
added_member_label string	Membership - Added member label
added_photo string	Photo - Added
added_repeat_event string	Calendar - Added repeating event
added_row string	Database - Added row
added_rss_integration string	Integration - Added feed integration
added_table string	Database - Added database
added_trello_integration string	Integration - Added Trello integration
added_webhook string	Integration - Added webhook
added_wiki_image string	Wiki - Image added
added_wiki_page string	Wiki - Page created
applied string	Membership - Pending member applied to group
approved_member string	Membership - Moderator approved new member
approved_pending_message string	Pending Message - Approved
attachments_deleted_for_space string	Message - Attachment deleted for space
attempt_sub_banned_member string	Banned - Member attempted to subscribe
attempted_banned_domain_owner string	Message - To +owner rejected from banned domain
attempted_banned_domain_post string	Rejected Message - Banned domain
attempted_banned_domain_registration string	Membership - System rejected potential member due to banned domain
attempted_file_add_with_virus string	File - Attempted add with virus
bad_expired_thread string	Bad expired thread
banned_by_system string	Banned - System banned member
banned_member string	Banned - Moderator banned member
bounced_user string	Bouncing - System bounced member
bouncing_user string	Bouncing - System set member to bouncing
canceled_event string	Calendar - Canceled event
changed_email string	Membership - Email address changed by member
changed_fullname string	Membership - Display name changed by member
changed_payer string	Billing - Invoice payer changed
changed_thread_replyto string	Topic - Reply-to changed
changed_thread_subject string	Topic - Subject changed
changed_username string	Membership - Username changed by member
claimed_pending_member string	Membership - Moderator claimed pending member
claimed_pending_message string	Pending Message - Claimed
closed_thread string	Topic - Locked
color_changed string	Membership - Moderator changed member subscription color
confirmed_account string	Account - Confirmed
created_group string	Group - Created
created_subgroup string	Subgroup - Created
deleted_account string	Account - Deleted
deleted_album string	Photo - Deleted album
deleted_alias string	Membership - Email alias deleted by member
deleted_attachment string	Message - Edited to delete attachment
deleted_banned_domain string	Banned - Domain deleted from banned list
deleted_chat_message string	Chat - Deleted message
deleted_dir string	File - Folder deleted
deleted_event string	Calendar - Deleted event
deleted_file string	File - Deleted
deleted_following_repeat_event string	Calendar - Deleted following repeating event
deleted_group_alias string	Group - Alias deleted
deleted_group_notice string	Member Notice - Deleted
deleted_message string	Message - Deleted
deleted_message_edit string	Message - Edit deleted
deleted_pending_member string	Membership - Moderator deleted pending member
deleted_pending_message string	Pending Message - Deleted
deleted_photo string	Photo - Deleted
deleted_repeat_event string	Calendar - Deleted repeating event
deleted_row string	Database - Deleted row
deleted_subgroup string	Subgroup - Deleted
deleted_table string	Database - Deleted database
deleted_thread string	Topic - Deleted
deleted_wiki_image string	Wiki - Image deleted
deleted_wiki_page string	Wiki - Page deleted
deleted_wiki_rev string	Wiki - Revision deleted
delivery_changed string	Membership - Email delivery changed by member
delivery_changed_by_moderator string	Membership - Email delivery changed by moderator
donation_closed string	Donation - Request closed
donation_reopened string	Donation - Request reopened
donation_requested string	Donation - Request created
donation_updated string	Donation - Request updated
edited_album string	Photo - Edited album
edited_bluesky_integration string	Integration - Edited Bluesky integration
edited_email_integration string	Integration - Edited email integration
edited_extra_data string	Membership - Extra data changed by member
edited_facebook_integration string	Integration - Edited Facebook integration
edited_github_integration string	Integration - Edited Github integration
edited_group string	Group - Settings changed
edited_group_notice string	Member Notice - Edited
edited_hashtag string	Hashtag - Edited
edited_instagram_integration string	Integration - Edited Instagram integration
edited_member_label string	Membership - Edited member label
edited_message string	Message - Edited
edited_message_no_send_unused string	Edited message without sending to the group
edited_moderator_note string	Membership - Member Notes edited by moderator
edited_photo string	Photo - Edited
edited_rss_integration string	Integration - Edited feed integration
edited_trello_integration string	Integration - Edited Trello integration
edited_webhook string	Integration - Edited webhook
event_changed_guests string	Calendar - Member guest count changed
event_changed_rsvp string	Calendar - Member RSVP changed
event_edited_comment string	Calendar - Member comment edited
event_moved_from_waitlist string	Calendar - Member moved off waitlist
event_removed_rsvp string	Calendar - Member removed from event
event_rsvp_maybe string	Calendar - Member RSVP \"not sure\"
event_rsvp_no string	Calendar - Member RSVP \"no\"
event_rsvp_yes string	Calendar - Member RSVP \"yes\"
expired_hashtag string	Topic - Deleted due to expired hashtag
expired_member string	Membership - Pending membership expired
expired_pending_message string	Pending Message - Expired
exported_group string	Group - Exported
extra_data_changed_by_moderator string	Membership - Extra data changed by moderator
extra_storage_added string	Billing - Extra storage added
extra_storage_removed string	Billing - Extra storage removed
guidelines_sent string	Group - Guidelines sent
invited_member string	Invitation - Sent
joined string	Membership - Member joined
left string	Membership - Member left
locked_event string	Calendar - Locked event
member_donated string	Donation - Made by member
member_donation_failed string	Donation - Failed by member
member_label_changed string	Membership - Moderator changed member's member labels
member_sponsored string	Group - Sponsorship made
member_sponsorship_failed string	Group - Sponsorship failed
member_tier_canceled string	Paid Memberships - Member canceled paid membership
member_tier_chargeback string	Paid Memberships - Chargeback opened on paid membership
member_tier_downgrade_applied string	Paid Memberships - Scheduled paid-membership downgrade took effect
member_tier_downgrade_released string	Paid Memberships - Member canceled a scheduled paid-membership downgrade
member_tier_downgrade_scheduled string	Paid Memberships - Member scheduled a paid-membership downgrade
member_tier_expired string	Paid Memberships - Paid membership expired
member_tier_manually_granted string	Paid Memberships - Admin granted a paid-membership tier to a member
member_tier_manually_revoked string	Paid Memberships - Admin revoked a paid-membership tier grant
member_tier_past_due string	Paid Memberships - Paid membership went past due
member_tier_payment_recovered string	Paid Memberships - Paid membership recovered from past due
member_tier_refunded string	Paid Memberships - Paid membership charge refunded
member_tier_resumed string	Paid Memberships - Member resumed canceled paid membership
member_tier_subscribe_orphan_cleaned string	Paid Memberships - Orphan subscription cleaned up
member_tier_subscribed string	Paid Memberships - Member subscribed to tier
member_tier_upgraded string	Paid Memberships - Member upgraded paid membership tier
merge_threads string	Topic - Merged topics
message_to_attendees string	Calendar - Message to attendees
mod_changed_email string	Membership - Email address changed by moderator
mod_changed_fullname string	Membership - Display name changed by moderator
moderated_thread string	Topic - Moderated
moderator_changed string	Membership - Moderator's permissions changed by moderator
modified_dir string	File - Folder modified
modified_event string	Calendar - Modified event
modified_file string	File - Modified
modified_repeat_event string	Calendar - Modified repeating event
modified_row string	Database - Modified row
modified_table string	Database - Modified database
modified_wiki_page string	Wiki - Page edited
monthly_reminder_sent string	Group - Monthly reminder sent
moved_dir string	File - Folder moved
moved_file string	File - Moved
moved_photo string	Photo - Moved
notifications_changed string	Membership - Notifications changed by member
notifications_changed_by_moderator string	Membership - Notifications changed by moderator
paid_invoice string	Billing - Invoice for group paid
paid_memberships_allow_default_tier_toggled string	Paid Memberships - Default tier at join toggled
paid_memberships_default_tier_edited string	Paid Memberships - Default tier edited
paid_memberships_disabled string	Paid Memberships - Disabled
paid_memberships_enabled string	Paid Memberships - Enabled
paid_memberships_join_abandoned string	Paid Memberships - Join checkout abandoned
paid_memberships_join_applied string	Paid Memberships - Join application submitted
paid_memberships_join_approval_revoked string	Paid Memberships - Join approval revoked
paid_memberships_join_approved string	Paid Memberships - Join application approved
paid_memberships_join_completed string	Paid Memberships - Join completed
paid_memberships_join_expired string	Paid Memberships - Awaiting-payment application expired
paid_memberships_join_orphan_refunded string	Paid Memberships - Orphaned join payment refunded
paid_memberships_join_pending_created string	Paid Memberships - Join checkout started
paid_memberships_join_reminder_sent string	Paid Memberships - Payment reminder sent
paid_memberships_join_withdrawn string	Paid Memberships - Join application withdrawn
paid_memberships_stripe_deauthorized string	Paid Memberships - Stripe account disconnected
paid_memberships_subgroup_access_changed string	Paid Memberships - Subgroup access changed
paid_memberships_subgroup_grandfathered_removed string	Paid Memberships - Grandfathered member removed from subgroup
paid_memberships_subgroup_reenable_reconciled string	Paid Memberships - Subgroup reconciled on re-enable
paid_memberships_subgroup_removed string	Paid Memberships - Removed from subgroup on tier change
plan_change string	Billing - Plan type changed
post_to_sub string	Message - To member
poststatus_changed string	Membership - Posting privileges changed by moderator
prevented_from_joining string	Membership - System prevented potential member from joining due to full group
reinvited_member string	Membership - Moderator re-sent invitation
rejected_member string	Membership - Moderator rejected pending member
rejected_pending_message string	Pending Message - Rejected
removed_bluesky_integration string	Integration - Removed Bluesky integration
removed_email_integration string	Integration - Removed email integration
removed_facebook_integration string	Integration - Removed Facebook integration
removed_github_integration string	Integration - Removed Github integration
removed_hashtag string	Hashtag - Removed
removed_instagram_integration string	Integration - Removed Instagram integration
removed_invite string	Invitation - Removed
removed_member string	Membership - Member removed
removed_member_label string	Membership - Removed member label
removed_rss_integration string	Integration - Removed feed integration
removed_trello_integration string	Integration - Removed Trello integration
removed_webhook string	Integration - Removed webhook
reopened_thread string	Topic - Unlocked
reported_file string	File - Reported
reported_message string	Message - Reported
reported_photo string	Photo - Reported
resent_confirmation string	Membership - Moderator re-sent confirmation email
resent_pending_member_notice string	Membership - Moderator re-sent pending member notice
resumed_membership string	Membership - Member resumed group membership
rotated_photo string	Photo - Rotated
sent_bounce_probe string	Bouncing - Bounce probe sent
sent_message_accepted string	Message - Sent
sent_message_announcement string	Rejected Message - To announcement group
sent_message_announcement_password string	Rejected Message - Incorrect announcement group password
sent_message_attachment_bounced string	Rejected Message - Due to attachment
sent_message_banned string	Rejected Message - Banned member
sent_message_bounced_sub string	Rejected Message - Bouncing member
sent_message_cant_add_event string	Calendar - No permission to add event
sent_message_cant_create_tags string	Rejected Message - New hashtag
sent_message_closed_topic string	Rejected Message - Locked topic
sent_message_mod_only_tags string	Rejected Message - Moderator-only hashtag
sent_message_moderated string	Pending Message - Received
sent_message_no_tags string	Rejected Message - No hashtag
sent_message_not_allowed string	Rejected Message - Member who can't post
sent_message_not_confirmed_sub string	Rejected Message - Not-confirmed member
sent_message_not_subscriber string	Rejected Message - Non-member
sent_message_pending_sub string	Rejected Message - Pending member
sent_message_too_big string	Rejected Message - Too large
sent_to_owner string	Message - To +owner
sig_changed string	Membership - Signature changed by member
sig_changed_by_moderator string	Membership - Signature changed by moderator
spam_left string	Spam - System removed member due to spam report
spam_sent_to_owner string	Message - Spam message to +owner
split_thread string	Topic - Split
sticky_thread string	Topic - Made sticky
stripe_account_connected string	Donations - Stripe account connected
stripe_account_disconnected string	Donations - Stripe account disconnected
sub_tier_id_drift_repaired string	Paid Memberships - Tier corrected by support
test_webhook string	Integration - Webhook test event
tier_created string	Paid Memberships - Tier created
tier_disabled string	Paid Memberships - Tier disabled
tier_edited string	Paid Memberships - Tier edited
tier_enabled string	Paid Memberships - Tier enabled
tier_hard_deleted string	Paid Memberships - Tier deleted
tier_price_created string	Paid Memberships - Tier price created
tier_price_deleted string	Paid Memberships - Tier price deleted
tier_price_disabled string	Paid Memberships - Tier price disabled
tier_restored string	Paid Memberships - Tier restored
tier_soft_deleted string	Paid Memberships - Tier soft-deleted
unbanned_member string	Banned - Moderator unbanned member
unbounced_user string	Bouncing - Member unbounced themselves
unlocked_event string	Calendar - Unlocked event
unmoderated_thread string	Topic - Unmoderated
unsticky_thread string	Topic - Unstuck
virus_bounced_member string	Rejected Message - From member due to virus
virus_bounced_nonmember string	Rejected Message - Non-member due to virus
virus_moderated_message string	Message from member required approval because of virus

The delivery_type type#

Possible Values

delivery_bounce_probe string	Bounce probe message
delivery_confirm_pending string	Pending email change confirmation
delivery_confirmation string	Confirmation email
delivery_digest string	Digest message
delivery_direct_add string	Direct add message
delivery_invite string	Invite delivery, not stored
delivery_login_link string	Login link message
delivery_member_notice string	Member notice
delivery_mod_notice string	Moderator notification, type is indicated by MsgID
delivery_reply string	Reply to sender
delivery_reverify string	Re-verification email
delivery_single string	Single message
delivery_summary string	Summary message
delivery_to_owner string	Message sent to a moderator via the +owner address
delivery_to_sub string	Message to subscriber

group_id required integer	ID of the group.
msg_num required number	The message number within the group.

API Reference - ALPHA

API Endpoints

Versioning And Change Log#

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

Success#

Errors#

Extended Return Information#

Pagination#

Libraries#

Authentication

Authentication Methods#

API Keys (Recommended)

Session-Based Authentication

Request Encoding And Responses#

Cookie and token login

Activity Log

Get Activity Log#

Archives

Get Topics#

Get Topic#

Get Message#

Get Messages#

Get Topic AI Summary#

Update Topic#

Download Archives#

Request Topic AI Summary#

Get Topic AI Summary Status#

Search Archives#

Get Message History#

Chats

New Chat#

Update Chat#

Get Chats#

Delete Chat#

Join Chat#

Chat Members#

Leave Chat#

Get Chat History#

Databases

Get Databases#

Get Database Rows#

Add Database Row#

Update Database Row#

Delete Database Row#

Delivery

Get Delivery Info#

Get Bounce Info#

Drafts

New Draft#

Update Draft#

Get Drafts#

None

Delete Draft#

Upload Attachments#

Get Attachments#

Delete Attachment#

Post Draft#

Events

Get Event#

Get Events#

RSVP To An Event#

Add Event#

Update Event#

Add Repeat Event#

Delete Event#

Update Repeat Event#

Delete Repeat Event#

Split Repeat Event#

Feed

Get Feed#

Get Single Feed#

Files

Add Files#

Add Link#

Get File Directory#

Get File#

Search Files#

Delete File#

Group

Create Group#