> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/facebook/groups/get](https://www.socialfetch.dev/docs/api/v1/facebook/groups/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/facebook/groups/get.mdx](https://www.socialfetch.dev/docs/api/v1/facebook/groups/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 184 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Get Facebook group (https://www.socialfetch.dev/docs/api/v1/facebook/groups/get)

## Summary

Get a Facebook group by URL or group id.

**Tags:** `Facebook`

## HTTP

- **Method:** GET
- **Path:** `/v1/facebook/groups`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.facebook.getGroup({ url?, groupId? })`
- **Accepted identifiers:** `url` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Agent notes

- **Disambiguation:** Pass a full Facebook group URL (`facebook.com/groups/{id-or-slug}/…`, including `/about`) or a numeric `groupId`. Profile and Page URLs belong on `GET /v1/facebook/profiles`. For the group feed, use `GET /v1/facebook/groups/posts`.
- **Empty results:** `lookupStatus: not_found` often means the group URL or ID was wrong, private, or unresolved.

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Normalization failure (502):** 1 credit charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `url` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 4096
- **Description:** Public Facebook group URL.

### `groupId` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 256; pattern: `^\d+$`
- **Description:** Numeric Facebook group id when you have it instead of a full URL.

## Responses (status codes)

- **200**: Group About-page profile.
- **400**: Invalid group URL, group ID, or bad request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Group About-page profile.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the group was found.
  - **group** (required) — type `object`; nullable. Group profile when available.
    - **platform** (required) — type `string`; enum: facebook. Social platform for this group.
    - **id** (required) — type `string`; minLength: 1. Numeric Facebook group identifier.
    - **url** (required) — type `string`; minLength: 1. Canonical public Facebook group URL.
    - **name** (required) — type `string`; nullable. Group display name when available.
    - **description** (required) — type `string`; nullable. Group description when available.
    - **createdAt** (required) — type `string`; nullable. When the group was created (ISO-8601).
    - **historySummary** (required) — type `string`; nullable. Human-readable group history summary when available.
    - **privacy** (required) — type `object`. Privacy setting for the group.
      - **label** (required) — type `string`; nullable. Short field label when available.
      - **description** (required) — type `string`; nullable. Longer explanation for this label when available.
    - **visibility** (required) — type `object`. Visibility setting for the group.
      - **label** (required) — type `string`; nullable. Short field label when available.
      - **description** (required) — type `string`; nullable. Longer explanation for this label when available.
    - **categories** (required) — type `array`. Categories assigned to the group.
      - _items:_
        - **id** (required) — type `string`; nullable. Category identifier when available.
        - **name** (required) — type `string`; minLength: 1. Category display name.
    - **memberCount** (required) — type `integer`; minimum: 0; nullable. Total member count when available.
    - **administratorCount** (required) — type `integer`; minimum: 0; nullable. Number of administrators when available.
    - **moderatorCount** (required) — type `integer`; minimum: 0; nullable. Number of moderators when available.
    - **administrators** (required) — type `array`. Administrators when Facebook exposes them.
      - _items:_
        - **id** (required) — type `string`; nullable. Platform identifier for this member when available.
        - **name** (required) — type `string`; nullable. Display name when available.
        - **url** (required) — type `string`; nullable. Public profile URL when available.
        - **profilePictureUrl** (required) — type `string`; nullable. Profile picture URL when available.
    - **moderators** (required) — type `array`. Moderators when Facebook exposes them.
      - _items:_
        - **id** (required) — type `string`; nullable. Platform identifier for this member when available.
        - **name** (required) — type `string`; nullable. Display name when available.
        - **url** (required) — type `string`; nullable. Public profile URL when available.
        - **profilePictureUrl** (required) — type `string`; nullable. Profile picture URL when available.
    - **activity** (required) — type `object`. Recent posting and membership activity.
      - **postsLastDay** (required) — type `integer`; minimum: 0; nullable. Posts published in the last day when available.
      - **postsLastMonth** (required) — type `integer`; minimum: 0; nullable. Posts published in the last month when available.
      - **newMembersText** (required) — type `string`; nullable. Human-readable new-member summary when available.
    - **rules** (required) — type `array`. Published group rules.
      - _items:_
        - **id** (required) — type `string`; nullable. Rule identifier when available.
        - **title** (required) — type `string`; minLength: 1. Short rule title.
        - **description** (required) — type `string`; nullable. Longer rule explanation when available.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **cached** (optional) — type `boolean`. True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "group": {
      "platform": "facebook",
      "id": "366190054572553",
      "url": "https://www.facebook.com/groups/366190054572553",
      "name": "Python Programming",
      "description": "Let's share our knowledge on Python Programming",
      "createdAt": "2020-10-14T11:05:03.000Z",
      "historySummary": "Group created on October 14, 2020. Name last changed on October 16, 2020.",
      "privacy": {
        "label": "Public",
        "description": "Anyone can see who's in the group and what they post."
      },
      "visibility": {
        "label": "Visible",
        "description": "Anyone can find this group."
      },
      "categories": [
        {
          "id": "242504017103922",
          "name": "Software & tech"
        }
      ],
      "memberCount": 721497,
      "administratorCount": 3,
      "moderatorCount": 0,
      "administrators": [
        {
          "id": "pfbid05pxyCbKSYATAqM2c3ZWdKEFWRSQ15sZqraPpQLsbFGXMe1jr88HRL4aCXCmRycxjl",
          "name": "Nusrat Jahan",
          "url": "https://www.facebook.com/people/Nusrat-Jahan/pfbid05pxyCbKSYATAqM2c3ZWdKEFWRSQ15sZqraPpQLsbFGXMe1jr88HRL4aCXCmRycxjl/",
          "profilePictureUrl": "https://scontent-bos5-1.xx.fbcdn.net/v/t39.30808-1/297738489_149183324449711_6655284279259187616_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx720x730&ctp=s32x32&_nc_cat=106&ccb=1-7&_nc_sid=e99d92&_nc_ohc=JaTez5Hhh5IQ7kNvwFXWOPg&_nc_oc=Adqo_IoUEWpraTz_d2ZqTa_N-1pnRHBKywgD2t0oEu-D1f0uXJJqu71Tmjc2ryw7a10&_nc_zt=24&_nc_ht=scontent-bo…"
        }
      ],
      "moderators": [],
      "activity": {
        "postsLastDay": 17,
        "postsLastMonth": 465,
        "newMembersText": "No new members in the last week"
      },
      "rules": [
        {
          "id": "366191957905696",
          "title": "Be Kind and Courteous",
          "description": "We're all in this together to create a welcoming environment. Let's treat everyone with respect. Healthy debates are natural, but kindness is required."
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_01example_facebook_group_found",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid group URL, group ID, or bad request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.facebook.getGroup({
  groupId: "366190054572553",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/facebook/groups?groupId=366190054572553",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/facebook/groups?groupId=366190054572553" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/facebook/groups?groupId=366190054572553",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```