facebook

Search › Groups

Returns public Facebook groups matching your keywords, one row per group, with the group's name, id and URL in the same shape the group endpoints take.

Use it when you need to find the groups to read before pulling their posts. Add include=details for member counts, descriptions and privacy.

Metered: 10–110 credits. We reserve the ceiling when the call starts and charge what it actually used when it finishes.

Paginates by cursor: see Pagination.

get/v1/facebook/search/groups

Request

Base URL: https://api.insightsocial.app
URL: https://api.insightsocial.app/v1/facebook/search/groups
Auth: API key in header x-api-key

Query parameters

querystring required

Example:vintage cars

Keywords describing the groups to find, for example vintage cars. Keywords only: the search is already limited to public Facebook groups, so a site: operator is refused before billing.

pageinteger

Page number, starting at 1. Forwarding pagination.next_cursor as cursor does the same.

include'details'

Set to details (one token only) to fill, on every group in this one call, author.followers (members), author.bio (the description), author.joined_at, author.ext.group.privacy_label, visibility_label, activity and id (the numeric group id), and the name where it was null. Without it the call is unchanged.

dry_run'1'

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

cursorstring

The pagination.next_cursor from the previous page, sent back unchanged. Omit it for the first page.

Response

Success.

successtrue required

platformstring required

endpointstring required

schema_version'2' required

unavailablestring[] required

credits_usedinteger required

credits_remaininginteger required

request_idstring required

cachedboolean required

idempotent_replayboolean required

charge_reasonstring required

free_callboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.