groupsSearch function

Returns a list of communities matching the search criteria

groupsSearch(
  q = "",
  type = "",
  country_id = "",
  city_id = "",
  future = 0,
  market = 0,
  sort = 0,
  offset = 0,
  count = 20,
  v = getAPIVersion()
)

Arguments

• q: Search query string

• type: Community type. Possible values: group, page, event

• country_id: Country ID

• city_id: City ID. If this parameter is transmitted, country_id is ignored

• future: 1 — to return only upcoming events. Works with the type = event only

• market: 1 — to return communities with enabled market only

• sort: Sort order. Possible values:

  • 0 — default sorting (similar the full version of the site);
  • 1 — by growth speed;
  • 2— by the "day attendance/members number" ratio;
  • 3 — by the "Likes number/members number" ratio;
  • 4 — by the "comments number/members number" ratio;
  • 5 — by the "boards entries number/members number" ratio.

• offset: Offset needed to return a specific subset of results

• count: Number of communities to return (default 20, maximum value 1000)

• v: Version of API