---
title: "Get a Skool user’s groups"
method: GET
path: "/v1/skool/user/groups"
tags: ["Skool"]
---

# Get a Skool user’s groups

`GET /v1/skool/user/groups`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/skool/user/groups`
- Auth: API key in header `x-api-key`

Read the community membership and created-group previews published on a profile, including community URLs and pricing. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `handle` string, required

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_page', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `memberOf` object[], required
      - `id` string, required
      - `name` string, nullable
      - `createdAt` string, nullable
      - `updatedAt` string, nullable
      - `url` string, uri, nullable
      - `metadata` object, required
        - `displayName` string, nullable
        - `description` string, nullable
        - `lpDescription` string, nullable
        - `color` string, nullable
        - `logoUrl` string, nullable
        - `logoBigUrl` string, nullable
        - `coverSmallUrl` string, nullable
        - `faviconUrl` string, nullable
        - `privacy` number, nullable
        - `membership` number, nullable
        - `membershipModel` number, nullable
        - `displayPrice` string, nullable
        - `monthlyPrice` number, nullable
        - `annualPrice` number, nullable
        - `monthlyCurrency` string, nullable
        - `totalMembers` number, nullable
        - `totalOnlineMembers` number, nullable
        - `totalAdmins` number, nullable
        - `totalPosts` number, nullable
        - `numCourses` number, nullable
        - `numModules` number, nullable
        - `reviewAverageRating` union
          - string
          - number
        - `reviewCount` number, nullable
      - `pricing` object
        - `monthly` object, nullable, required
          - `currency` string, required
          - `amount` number, required
        - `annual` object, nullable, required
          - `currency` string, required
          - `amount` number, required
      - `owner` object
        - `id` string, required
        - `name` string, nullable
        - `createdAt` string, nullable
        - `updatedAt` string, nullable
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `url` string, uri, nullable
        - `metadata` object, required
          - `bio` string, nullable
          - `location` string, nullable
          - `pictureProfile` string, nullable
          - `pictureBubble` string, nullable
          - `linkFacebook` string, nullable
          - `linkInstagram` string, nullable
          - `linkLinkedin` string, nullable
          - `linkTwitter` string, nullable
          - `linkWebsite` string, nullable
          - `linkYoutube` string, nullable
        - `membership` object
          - `id` string, required
          - `groupId` string, required
          - `userId` string, required
          - `createdAt` string, nullable
          - `updatedAt` string, nullable
          - `approvedAt` string, nullable
          - `role` string, nullable
        - `gamification` object
          - `points` number, nullable
          - `level` number, nullable
      - `links` object[]
        - `url` string, uri, required
        - `label` string, nullable
      - `labels` object[]
        - `id` string, required
        - `name` string, nullable
        - `createdAt` string, nullable
        - `updatedAt` string, nullable
        - `groupId` string, nullable
        - `metadata` object, required
          - `displayName` string, nullable
          - `color` string, nullable
          - `description` string, nullable
          - `posts` number, nullable
      - `media` object[]
        - `id` string, required
        - `type` number, nullable
        - `image` object
          - `originalUrl` string, uri, nullable
          - `smallUrl` string, uri, nullable
          - `bigUrl` string, uri, nullable
        - `video` object
          - `url` string, uri, nullable
          - `thumbnail` string, uri, nullable
      - `reviews` object
        - `items` object[], required
          - `id` string, required
          - `name` string, nullable
          - `createdAt` string, nullable
          - `updatedAt` string, nullable
          - `groupId` string, nullable
          - `userId` string, nullable
          - `rating` number, nullable
          - `body` string, nullable
          - `memberSince` string, nullable
          - `user` object
            - `id` string, required
            - `name` string, nullable
            - `createdAt` string, nullable
            - `updatedAt` string, nullable
            - `firstName` string, nullable
            - `lastName` string, nullable
            - `first_name` string, nullable
            - `last_name` string, nullable
            - `url` string, uri, nullable
            - `metadata` object, required
              - …
            - `membership` object
              - …
            - `gamification` object
              - …
        - `hasMore` boolean, nullable, required
        - `total` number, nullable, required
        - `averageRating` number, nullable, required
    - `created` object[], required
      - `id` string, required
      - `name` string, nullable
      - `createdAt` string, nullable
      - `updatedAt` string, nullable
      - `url` string, uri, nullable
      - `metadata` object, required
        - `displayName` string, nullable
        - `description` string, nullable
        - `lpDescription` string, nullable
        - `color` string, nullable
        - `logoUrl` string, nullable
        - `logoBigUrl` string, nullable
        - `coverSmallUrl` string, nullable
        - `faviconUrl` string, nullable
        - `privacy` number, nullable
        - `membership` number, nullable
        - `membershipModel` number, nullable
        - `displayPrice` string, nullable
        - `monthlyPrice` number, nullable
        - `annualPrice` number, nullable
        - `monthlyCurrency` string, nullable
        - `totalMembers` number, nullable
        - `totalOnlineMembers` number, nullable
        - `totalAdmins` number, nullable
        - `totalPosts` number, nullable
        - `numCourses` number, nullable
        - `numModules` number, nullable
        - `reviewAverageRating` union
          - string
          - number
        - `reviewCount` number, nullable
      - `pricing` object
        - `monthly` object, nullable, required
          - `currency` string, required
          - `amount` number, required
        - `annual` object, nullable, required
          - `currency` string, required
          - `amount` number, required
      - `owner` object
        - `id` string, required
        - `name` string, nullable
        - `createdAt` string, nullable
        - `updatedAt` string, nullable
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `url` string, uri, nullable
        - `metadata` object, required
          - `bio` string, nullable
          - `location` string, nullable
          - `pictureProfile` string, nullable
          - `pictureBubble` string, nullable
          - `linkFacebook` string, nullable
          - `linkInstagram` string, nullable
          - `linkLinkedin` string, nullable
          - `linkTwitter` string, nullable
          - `linkWebsite` string, nullable
          - `linkYoutube` string, nullable
        - `membership` object
          - `id` string, required
          - `groupId` string, required
          - `userId` string, required
          - `createdAt` string, nullable
          - `updatedAt` string, nullable
          - `approvedAt` string, nullable
          - `role` string, nullable
        - `gamification` object
          - `points` number, nullable
          - `level` number, nullable
      - `links` object[]
        - `url` string, uri, required
        - `label` string, nullable
      - `labels` object[]
        - `id` string, required
        - `name` string, nullable
        - `createdAt` string, nullable
        - `updatedAt` string, nullable
        - `groupId` string, nullable
        - `metadata` object, required
          - `displayName` string, nullable
          - `color` string, nullable
          - `description` string, nullable
          - `posts` number, nullable
      - `media` object[]
        - `id` string, required
        - `type` number, nullable
        - `image` object
          - `originalUrl` string, uri, nullable
          - `smallUrl` string, uri, nullable
          - `bigUrl` string, uri, nullable
        - `video` object
          - `url` string, uri, nullable
          - `thumbnail` string, uri, nullable
      - `reviews` object
        - `items` object[], required
          - `id` string, required
          - `name` string, nullable
          - `createdAt` string, nullable
          - `updatedAt` string, nullable
          - `groupId` string, nullable
          - `userId` string, nullable
          - `rating` number, nullable
          - `body` string, nullable
          - `memberSince` string, nullable
          - `user` object
            - `id` string, required
            - `name` string, nullable
            - `createdAt` string, nullable
            - `updatedAt` string, nullable
            - `firstName` string, nullable
            - `lastName` string, nullable
            - `first_name` string, nullable
            - `last_name` string, nullable
            - `url` string, uri, nullable
            - `metadata` object, required
              - …
            - `membership` object
              - …
            - `gamification` object
              - …
        - `hasMore` boolean, nullable, required
        - `total` number, nullable, required
        - `averageRating` number, nullable, required
    - `total` number, nullable, required
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `failure` object, required
      - `code` 'restricted' | 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)