Sign in

v1

latestSwagger 2.02026-07-1312672.0 KB
groups

Retrieve a group

get/groups/{group_id}

Path parameters

group_idstring required

The ID of the group to retrieve.

Response

The group.

group_idstring
namestring

The name of the group (not guaranteed to be unique).

identifierstring

A unique identifier for the group that is used in URLs.

homepagestring

A URL to the group homepage.

member_countinteger

The number of members who belong to the group.

latitudenumber
longitudenumber
timezonestring

The timezone that the group is in (eg. America/New_York).

open_membershipboolean

When true, the group allows anyone to join. When false, the group moderators review and approve applicants.

open_archivesboolean

When true, the group posts are viewable by anyone. When false, the group posts can only be viewed by members of the group.

has_questionsboolean

When true, anyone requesting membership to this group will be required to answer a new membership questionnaire.

Example response

{
  "group_id": 46,
  "name": "Ottawa Reuse",
  "identifier": "OttawaReuse",
  "homepage": "https://trashnothing.com/OttawaReuse",
  "member_count": 4838,
  "latitude": 45.423494,
  "longitude": -75.697933,
  "timezone": "America/Toronto",
  "open_membership": false,
  "open_archives": false,
  "has_questions": true,
  "country": {
    "name": "Canada",
    "abbreviation": "CA"
  },
  "region": {
    "name": "Ontario",
    "abbreviation": "ON"
  },
  "membership": {
    "status": "pending-questions",
    "date": "2015-01-22T17:05:50",
    "questionnaire": {
      "message": "This group is only for people who live in Ottawa.",
      "questions": [
        "Where do you live?"
      ]
    }
  }
}