Sign in

v1

latestSwagger 2.02026-07-1312672.0 KB
groups

Search groups

get/groups

Query parameters

namestring

Find groups that have the given text somewhere in their name (case insensitive).

latitudenumber

Find groups near the given latitude and longitude.

longitudenumber

Find groups near the given latitude and longitude.

distancenumber

When latitude and longitude are passed, distance can optionally be passed to only return groups within a certain distance (in kilometers) from the point specified by the latitude and longitude. The distance must be > 0 and <= 150 and will default to 100.

countrystring

Find groups in the given country where country is a 2 letter country code for the country (see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ).

regionstring

For countries with regions (AU, CA, GB, US), search groups in a specific region as specified by the region abbreviation. The supported regions and their abbreviations are listed below. <br /><br /> NOTE: The region and postal_code parameters cannot be used at the same time and if both are passed then the postal_code will take priority. <br /><br /> --- <br /><br /> AU<br /> - QLD: Queensland<br /> - SA: South Australia<br /> - TAS: Tasmania<br /> - VIC: Victoria<br /> - WA: Western Australia<br /> - NT: Northern Territory<br /> - NSW: New South Wales - ACT<br /> <br /> CA<br /> - AB: Alberta<br /> - BC: British Columbia<br /> - MB: Manitoba<br /> - NB: New Brunswick<br /> - NL: Newfoundland and Labrador<br /> - NS: Nova Scotia<br /> - ON: Ontario<br /> - QC: Quebec<br /> - SK: Saskatchewan<br /> - PE: Prince Edward Island<br /> <br /> GB<br /> - E: East<br /> - EM: East Midlands<br /> - LDN: London<br /> - NE: North East<br /> - NW: North West<br /> - NI: Northern Ireland<br /> - SC: Scotland<br /> - SE: South East<br /> - SW: South West<br /> - WA: Wales<br /> - WM: West Midlands<br /> - YH: Yorkshire and the Humber<br /> <br /> US<br /> All 50 states and the District of Columbia are supported. For the abbreviations, see: https://github.com/jasonong/List-of-US-States/blob/master/states.csv

postal_codestring

Find groups in the given postal code. Only a few countries support postal code searches (US, CA, AU, GB). The country parameter must be passed when the postal_code parameter is set. <br /><br /> NOTE: The region and postal_code parameters cannot be used at the same time and if both are passed then the postal_code will take priority.

pageinteger

The page of groups to return.

per_pageinteger

The number of groups to return per page (must be >= 1 and <= 100).

Response

The groups and paging data.

num_groupsinteger

The total number of groups available.

pageinteger

The page number of the groups being returned.

per_pageinteger

The number of groups being returned per page.

num_pagesinteger

The total number of pages available.

start_indexinteger

The index of the first group being returned (an integer between 1 and num_groups).

end_indexinteger

The index of the last group being returned (an integer between start_index and num_groups).

Example response

{
  "groups": [
    {
      "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?"
          ]
        }
      }
    }
  ]
}