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: 20–300 credits. We reserve the ceiling when the call starts and charge what it actually used when it finishes.
Re-running the exact same call within 1h is free.
Paginates by cursor — see Pagination.
Authorization
apiKey Your key from the dashboard. It starts with isk_.
In: header
Query Parameters
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.
Page number, starting at 1. Forwarding pagination.next_cursor as cursor does the same.
1 <= valueSet 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.
Value in
- "details"
Optional. Without this param every row already carries computed.relevance against your query, free ({ p, sense, depth, spam }: is this row about what your query means, or a different thing that shares its words?), and nothing is dropped or reordered. score asks for it explicitly and waits for every row; filter also drops the rows that are not about your query, and lists their ids in data.relevance.dropped_ids. Your query is the topic; nothing to configure. A row that could not be judged is never dropped and carries relevance: null. Pagination is unchanged, so a filtered page can hold fewer rows.
Value in
- "score"
- "filter"
Optional, only with relevance. The probability (0 to 1) a row must reach to be kept by relevance=filter. Default 0.5. Lower keeps more rows, higher keeps fewer.
Optional, only with relevance. Up to 200 characters describing what you mean, used as the topic instead of the query. Use it when the query is ambiguous, for example query=cleopatra with relevant_to=Cleopatra, the IGT slot game.
Optional, on (the default) or off. By default every row gains free judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
Value in
- "on"
- "off"
Optional. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
Value in
- "1"
Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache. Without this param the page is unchanged.
Value in
- "goal"
Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/facebook/search/groups?query=string"{ "success": true, "platform": "instagram", "endpoint": "/v1/instagram/profile/posts", "data": { "items": [ "…" ], "dropped": 0 }, "pagination": { "next_cursor": "is2.eyJwIjoyfQ", "has_more": true, "page_size": 12 }, "credits_used": 20, "credits_remaining": 9980, "request_id": "req_1a2b3c4d5e6f", "cached": false, "idempotent_replay": false, "charge_reason": "miss", "free_call": false}Profile GET
Returns a Facebook page's public profile: page id, display name, profile image, bio, follower count, and page-like count. Use it when you have a page URL and want a quick snapshot before pulling that page's posts, photos, or reels. **20 credits** per call. Re-running the exact same call within 24h is free.
Search › Pages GET
Returns Facebook pages matching a keyword, each with page id, display name, permalink, avatar, and verified flag. Use it to find pages by name; follower counts are not on this card, so take author.url to profile for the full page. **20 credits** per call. Re-running the exact same call within 1h is free. Paginates by `cursor` — see [Pagination](/docs/pagination).