groups

groups.search

Returns a list of communities matching the search criteria.

To call this method, you can use:

Parameters

q

string

Search query string.

Required parameter

type

string

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

country_id

positive

Country ID.

city_id

positive

City ID. If this parameter is transmitted, country_id is ignored.

future

checkbox

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

market

checkbox

1 — to return communities with enabled market only.

sort

integer

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

positive

Offset needed to return a specific subset of results.

count

positive

Number of communities to return.

Note that you can not receive more than first thousand of results, regardless of count and offset values.

Result

Returns the total results number in count field and an array of objects describing communities in items field.

Error codes

Common errors may occur during execution

Linked versions

Go to API versions page
5.54

If no end date is specified in the method call parameters, return objects that describe community They no longer have a field.. finish_data . Previously, this field was present in the response and contained the default, equal to start_date + 2 hours.

5.53

can_message, ban_info, can_post, can_upload_doc, can_upload_video, can_see_all_posts, can_create_topic, is_favorite, is_hidden_from_feed fields in a community object are returned for the requests including access_token only.

5.19
  • •

    In the object that describes community The type of fields has changed. start_date and finish_date From string to numeric.

  • •

    Methods that work with news, when the filter is installed friend Return the field user_id instead of uid .

  • •

    In the method fave.getLinks Images are returned in the fields photo_50 and photo_100 instead of image_src and image_middle .