/circle/communities

POST /api/circle/communities

Price: 5 credits

Get a Circle Discover community or course by URL or slug: descriptions, price and payment plans, outcomes, what is included, goals, category, media highlights and the creator's profile.

How to use it

Profile one paid or free community listed on Circle Discover. Find slugs with circle/communities/search; the creator alias feeds circle/creators.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• community string required — Circle Discover product URL or its slug (examples: "https://discover.circle.so/products/archaix-underground", "archaix-underground"; minLength: 1)

Response

• @type string (default: "CircleCommunity")
• id string required
• alias string required
• name string required
• url string required
• short_description string nullable
• price number nullable
• price_label string nullable
• image string nullable
• video_url string nullable
• description string nullable
• status string nullable
• cta_type string nullable
• community_id string nullable
• community_name string nullable
• category_id string nullable
• category_name string nullable
• tags array (default: [])
• outcomes array (default: [])
• audiences array (default: [])
• whats_included array (default: [])
  • @type string (default: "CircleIncludedItem")
  • text string nullable
  • icon string nullable
• goals array (default: [])
  • @type string (default: "CircleGoal")
  • id string required
  • alias string required
  • name string required
  • description string nullable
• payment_options array (default: [])
  • @type string (default: "CirclePaymentOption")
  • id string required
  • name string nullable
  • price_type string nullable
  • amount number nullable
  • upfront_payment_amount number nullable
  • installment_amount number nullable
  • installment_count integer nullable
  • interval string nullable
  • interval_count integer nullable
  • trial_days integer nullable
  • checkout_url string nullable
• highlights array (default: [])
  • @type string (default: "CircleHighlight")
  • id string required
  • media_type string nullable
  • url string required
  • thumbnail string nullable
  • duration number nullable
• thumbnail string nullable
• external_url string nullable
• creator object nullable
  • @type string (default: "CircleCreatorProfile")
  • id string required
  • alias string required
  • name string required
  • url string required
  • headline string nullable
  • bio string nullable
  • image string nullable
  • cover string nullable
  • intro_video_url string nullable
  • links array (default: [])
    • @type string (default: "CircleLink")
    • url string required
    • link_type string nullable
  • status string nullable
  • created_at integer nullable
  • joined_at integer nullable
• created_at integer nullable
• updated_at integer nullable
• published_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 Circle Discover product 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.