Circle Community Exporter
Pricing
from $2.00 / 1,000 member exporteds
Export a Circle.so community you own or administer. Members, posts, comments, courses, and your own DMs, into structured data. Read-only.
Pricing
from $2.00 / 1,000 member exporteds
Rating
0.0
(0)
Developer
Utopian Vision
Maintained by CommunityActor stats
0
Bookmarked
1
Total users
0
Monthly active users
a day ago
Last modified
Categories
Share
You can access the Circle Community Exporter programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.6", "x-build-id": "eFZ9Shk73oFpPK21X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/utopianvision~circle-community-exporter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-utopianvision-circle-community-exporter", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/utopianvision~circle-community-exporter/runs": { "post": { "operationId": "runs-sync-utopianvision-circle-community-exporter", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/utopianvision~circle-community-exporter/run-sync": { "post": { "operationId": "run-sync-utopianvision-circle-community-exporter", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "communityUrl", "sessionCookie" ], "properties": { "communityUrl": { "title": "Community URL", "type": "string", "description": "The base URL of your Circle community, e.g. https://your-community.circle.so or your custom domain (https://community.yourbrand.com). No trailing path." }, "sessionCookie": { "title": "Session cookie", "type": "string", "description": "Your own logged-in Circle session cookie. Copy the full Cookie header from your browser's developer tools while signed in to your community (see the README for the step-by-step). Stored encrypted and never logged." }, "bearerJwt": { "title": "Bearer token (advanced, optional)", "type": "string", "description": "Leave blank. The course access token is now detected automatically from your session cookie. Only set this as a fallback if course export reports that no token was found. See the README." }, "exportMembers": { "title": "Export members", "type": "boolean", "description": "Export the member directory.", "default": true }, "fullProfiles": { "title": "Full member profiles", "type": "boolean", "description": "Fetch each member's full profile (one extra request per member - slower and more chargeable events).", "default": false }, "exportPosts": { "title": "Export posts", "type": "boolean", "description": "Export posts across all non-course spaces.", "default": true }, "exportComments": { "title": "Export comments", "type": "boolean", "description": "Also export comments on each post (only applies when Export posts is on).", "default": true }, "exportCourses": { "title": "Export course content (advanced)", "type": "boolean", "description": "Export course/classroom lessons, files, and transcripts. May require the Bearer token for some lessons.", "default": false }, "exportDms": { "title": "Export your own DMs (advanced)", "type": "boolean", "description": "Export your own direct-message history. This only ever covers YOUR account's conversations - Circle does not expose other members' private messages. Off by default.", "default": false }, "csvArtifacts": { "title": "Write CSV files + summary", "type": "boolean", "description": "At the end of the run, also write tidy per-type CSV files (members.csv, posts.csv, comments.csv, lessons.csv, dms.csv) and a SUMMARY.md to the run's key-value store, alongside the full JSON dataset.", "default": true }, "sinceDate": { "title": "Only activity since (incremental)", "type": "string", "description": "Optional. An ISO date like 2026-01-31. When set, only posts, comments, and DMs created on or after this date are exported - the 'new activity since my last backup' case. Members and course content are always exported in full. Leave blank for a complete export." }, "downloadMedia": { "title": "Download media files (off by default)", "type": "boolean", "description": "Also download the actual binary assets a record points at (member avatars, lesson files, post/comment attachments) into the run's key-value store as media- records, not just their URLs. Slower and adds a per-file charge; files over 9 MB are skipped. Leave off unless you want a full archival copy.", "default": false }, "maxPages": { "title": "Max directory pages", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap on member-directory pagination. Raise for very large communities.", "default": 200 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Circle Community Exporter from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: