/circle/communities/search

POST /api/circle/communities/search

Price: 20 credits

Search communities and courses on Circle Discover by keyword, goal, type and price range: each with name, short description, price and cover image.

How to use it

Find paid or free creator communities and courses on Circle Discover. A goal alone, with no query, lists everything under that goal. Feed alias into circle/communities for full details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Search keywords (examples: "yoga"; minLength: 1)
• goal string nullable — Only listings tagged with this goal (one of: "advance-my-career", "be-more-productive", "build-my-tech-skills", "grow-my-brand-and-audience", "grow-my-network", "grow-my-wealth", "improve-my-health", "lead-with-confidence", "learn-ai", "pursue-new-interests", "start-and-scale-my-business", "strengthen-my-relationships"; examples: "improve-my-health")
• listing_type string nullable — Only communities or only courses (one of: "community", "course"; examples: "community")
• min_price number nullable — Minimum price in US dollars (examples: 10; min: 0)
• max_price number nullable — Maximum price in US dollars (examples: 50; min: 0)
• count integer required — Max number of listings to return (min: 1; max: 270)

Response

• @type string (default: "CircleSearchListing")
• 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

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 — The entity was not found, or a precondition failed 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.