Skip to content
scrapeatlas.Dashboard

Get a Skool community

Try in Playground

Read community identity, monthly and annual pricing, counts, owner details, public links, categories, landing images and videos, ratings and review previews.

GET/v1/skool/communityx-api-key
x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters
1
groupstringrequiredquery

Canonical community slug, e.g. ai-automation-society. No URL, credentials, slash, query or fragment.

Exampleai-automation-society
Response fields
133
requestIdstring

Operational correlation UUID.

Upstream attempts, decoded success-body bytes and duration. Error bodies are cancelled.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable data is returned.

statusenum

success or partial; failed/challenged on errors.

one of: success, partial

sourceUrlstring

Fixed-origin canonical Skool page read.

absolute HTTPS URL

fetchedAtstring

UTC retrieval time.

Extraction source, completeness flag and machine-readable warning codes.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

Community identity, metadata, owner, URL, pricing, public links, category labels, media and review previews.

community.idstring

Always included.

min 1 chars

community.namestringnullableoptional

Optional.

community.createdAtstringnullableoptional

Optional.

community.updatedAtstringnullableoptional

Optional.

community.urlstringnullableoptional

Optional.

Always included.

community.metadata.displayNamestringnullableoptional

Optional.

community.metadata.descriptionstringnullableoptional

Optional.

community.metadata.lpDescriptionstringnullableoptional

Optional.

community.metadata.colorstringnullableoptional

Optional.

community.metadata.logoUrlstringnullableoptional

Optional.

community.metadata.logoBigUrlstringnullableoptional

Optional.

community.metadata.coverSmallUrlstringnullableoptional

Optional.

community.metadata.faviconUrlstringnullableoptional

Optional.

community.metadata.privacynumbernullableoptional

Optional.

community.metadata.membershipnumbernullableoptional

Optional.

community.metadata.membershipModelnumbernullableoptional

Optional.

community.metadata.displayPricestringnullableoptional

Optional.

community.metadata.monthlyPricenumbernullableoptional

Optional.

community.metadata.annualPricenumbernullableoptional

Optional.

community.metadata.monthlyCurrencystringnullableoptional

Optional.

community.metadata.totalMembersnumbernullableoptional

Optional.

community.metadata.totalOnlineMembersnumbernullableoptional

Optional.

community.metadata.totalAdminsnumbernullableoptional

Optional.

community.metadata.totalPostsnumbernullableoptional

Optional.

community.metadata.numCoursesnumbernullableoptional

Optional.

community.metadata.numModulesnumbernullableoptional

Optional.

community.metadata.reviewAverageRatingstring | numbernullableoptional

Optional.

community.metadata.reviewCountnumbernullableoptional

Optional.

Monthly and annual price objects with currency and source amount in minor currency units (USD cents).

Always included.

community.pricing.monthly.currencystring

Always included.

community.pricing.monthly.amountnumber

Always included.

≥ 0

Always included.

community.pricing.annual.currencystring

Always included.

community.pricing.annual.amountnumber

Always included.

≥ 0

Optional.

community.owner.idstring

Always included.

min 1 chars

community.owner.namestringnullableoptional

Optional.

community.owner.createdAtstringnullableoptional

Optional.

community.owner.updatedAtstringnullableoptional

Optional.

community.owner.firstNamestringnullableoptional

Optional.

community.owner.lastNamestringnullableoptional

Optional.

community.owner.first_namestringnullableoptional

Optional.

community.owner.last_namestringnullableoptional

Optional.

community.owner.urlstringnullableoptional

Optional.

Always included.

community.owner.metadata.biostringnullableoptional

Optional.

community.owner.metadata.locationstringnullableoptional

Optional.

community.owner.metadata.pictureProfilestringnullableoptional

Optional.

community.owner.metadata.pictureBubblestringnullableoptional

Optional.

community.owner.metadata.linkFacebookstringnullableoptional

Optional.

community.owner.metadata.linkInstagramstringnullableoptional

Optional.

community.owner.metadata.linkLinkedinstringnullableoptional

Optional.

community.owner.metadata.linkTwitterstringnullableoptional

Optional.

community.owner.metadata.linkWebsitestringnullableoptional

Optional.

community.owner.metadata.linkYoutubestringnullableoptional

Optional.

Optional.

community.owner.membership.idstring

Always included.

min 1 chars

community.owner.membership.groupIdstring

Always included.

min 1 chars

community.owner.membership.userIdstring

Always included.

min 1 chars

community.owner.membership.createdAtstringnullableoptional

Optional.

community.owner.membership.updatedAtstringnullableoptional

Optional.

community.owner.membership.approvedAtstringnullableoptional

Optional.

community.owner.membership.rolestringnullableoptional

Optional.

Optional.

community.owner.gamification.pointsnumbernullableoptional

Optional.

community.owner.gamification.levelnumbernullableoptional

Optional.

Published links with their labels and destinations.

up to 100 items

community.links.urlstring

Always included.

absolute HTTPS URL

community.links.labelstringnullableoptional

Optional.

Category IDs, display names, descriptions, colors and post counts.

up to 100 items

community.labels.idstring

Always included.

min 1 chars

community.labels.namestringnullableoptional

Optional.

community.labels.createdAtstringnullableoptional

Optional.

community.labels.updatedAtstringnullableoptional

Optional.

community.labels.groupIdstringnullableoptional

Optional.

Always included.

community.labels.metadata.displayNamestringnullableoptional

Optional.

community.labels.metadata.colorstringnullableoptional

Optional.

community.labels.metadata.descriptionstringnullableoptional

Optional.

community.labels.metadata.postsnumbernullableoptional

Optional.

Landing media identifiers, image URLs, video URLs and thumbnails.

up to 100 items

community.media.idstring

Always included.

min 1 chars

community.media.typenumbernullableoptional

Optional.

Optional.

community.media.image.originalUrlstringnullableoptional

Optional.

community.media.image.smallUrlstringnullableoptional

Optional.

community.media.image.bigUrlstringnullableoptional

Optional.

Optional.

community.media.video.urlstringnullableoptional

Optional.

community.media.video.thumbnailstringnullableoptional

Optional.

Review items, source hasMore, total count and numeric averageRating. Metadata reviewAverageRating retains its source type.

Always included.

up to 100 items

community.reviews.items.idstring

Always included.

min 1 chars

community.reviews.items.namestringnullableoptional

Optional.

community.reviews.items.createdAtstringnullableoptional

Optional.

community.reviews.items.updatedAtstringnullableoptional

Optional.

community.reviews.items.groupIdstringnullableoptional

Optional.

community.reviews.items.userIdstringnullableoptional

Optional.

community.reviews.items.ratingnumbernullableoptional

Optional.

community.reviews.items.bodystringnullableoptional

Optional.

community.reviews.items.memberSincestringnullableoptional

Optional.

Optional.

community.reviews.items.user.idstring

Always included.

min 1 chars

community.reviews.items.user.namestringnullableoptional

Optional.

community.reviews.items.user.createdAtstringnullableoptional

Optional.

community.reviews.items.user.updatedAtstringnullableoptional

Optional.

community.reviews.items.user.firstNamestringnullableoptional

Optional.

community.reviews.items.user.lastNamestringnullableoptional

Optional.

community.reviews.items.user.first_namestringnullableoptional

Optional.

community.reviews.items.user.last_namestringnullableoptional

Optional.

community.reviews.items.user.urlstringnullableoptional

Optional.

community.reviews.items.user.metadataobject

Always included.

community.reviews.items.user.membershipobjectoptional

Optional.

community.reviews.items.user.gamificationobjectoptional

Optional.

community.reviews.hasMorebooleannullable

Always included.

community.reviews.totalnumbernullable

Always included.

community.reviews.averageRatingnumbernullable

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes
0
HTTPfailure.codeMeaning