/skool/communities

POST /api/skool/communities

Price: 10 credits

Get a Skool community by URL or slug: name, descriptions, price, privacy, member, post and course counts, rating, membership tiers, owner profile and the first reviews.

How to use it

Profile one Skool community from its skool.com URL. For every review beyond the first few, call skool/communities/reviews with the same slug.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• community string required — Skool community URL or its slug (examples: "https://www.skool.com/adcreatorslab/about", "adcreatorslab"; minLength: 1)

Response

• @type string (default: "SkoolCommunity")
• id string required
• alias string required
• name string required
• url string required
• description string nullable
• landing_description string nullable
• is_private boolean nullable
• price number nullable
• currency string nullable
• billing_interval string nullable
• member_count integer nullable
• online_member_count integer nullable
• admin_count integer nullable
• post_count integer nullable
• course_count integer nullable
• module_count integer nullable
• rule_count integer nullable
• rating number nullable
• review_count integer nullable
• affiliate_commission_percent number nullable
• image string nullable
• cover string nullable
• favicon string nullable
• color string nullable
• enabled_tabs array (default: [])
• landing_media array (default: [])
• welcome_video_url string nullable
• membership_tiers array (default: [])
  • @type string (default: "SkoolMembershipTier")
  • id string required
  • tier string nullable
  • model string nullable
  • benefits array (default: [])
  • has_monthly_billing boolean required
  • has_annual_billing boolean required
  • has_one_time_billing boolean required
  • activated_at integer nullable
• owner object nullable
  • @type string (default: "SkoolOwner")
  • id string required
  • alias string nullable
  • first_name string nullable
  • last_name string nullable
  • bio string nullable
  • location string nullable
  • image string nullable
  • links array (default: [])
  • time_zone string nullable
  • created_at integer nullable
• reviews array (default: [])
  • @type string (default: "SkoolReview")
  • id string required
  • community_id string nullable
  • rating integer nullable
  • text string nullable
  • created_at integer nullable
  • updated_at integer nullable
  • member_since_at integer nullable
  • is_paying_member boolean nullable
  • author object nullable
    • @type string (default: "SkoolUser")
    • id string required
    • alias string nullable
    • first_name string nullable
    • last_name string nullable
    • bio string nullable
    • image string nullable
• created_at integer nullable
• updated_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No Skool community at this slug Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.