Search Paywalls
search_paywallsFind paywalls in Circle communities by name, status, or currency. Supports filtered, paginated results, with optional bounded all-pages reads that consume API quota.
Instructions
Search Paywalls. Reads community data. Supports bounded all_pages; every page counts against the API quota.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter by paywall name or display name (partial match) | |
| page | No | Page number | |
| sort | No | Sort field (one of: title, status, created_at). Defaults to created_at | |
| status | No | Comma-separated list of statuses (e.g. draft,active,inactive) | |
| account | No | Named private Circle account; selects credentials, not a remote community ID. | |
| currency | No | Comma-separated list of currency codes | |
| per_page | No | Records per page (max 100) | |
| all_pages | No | Read bounded page/per_page pages; each request consumes API quota. Not a snapshot or guaranteed complete backup. | |
| direction | No | Sort direction (asc or desc). Defaults to desc. Only takes effect when sort is also given -- direction alone is ignored | |
| max_items | No | Maximum returned records with all_pages=true, default 1000. At most 100 requests; output includes continuation state. | |
| paywall_id | No | Comma-separated list of paywall IDs to include | |
| exclude_paywall_id | No | Comma-separated list of paywall IDs to exclude | |
| subscription_group_id | No | Comma-separated list of subscription group IDs to include | |
| exclude_subscription_group_id | No | Comma-separated list of subscription group IDs to exclude |