{ "openapi": "3.0.1", "info": { "title": "Skool API", "description": "Find public Skool communities from keywords or public URLs, or look up a community by URL or public identifier. Get public profiles, visible member details, and source discovery rank when provided, with category and access filters.", "version": "0.0", "x-build-id": "BKOpcbgoXV3GI5wRJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~skool-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-skool-api", "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/maximedupre~skool-api/runs": { "post": { "operationId": "runs-sync-maximedupre-skool-api", "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/maximedupre~skool-api/run-sync": { "post": { "operationId": "run-sync-maximedupre-skool-api", "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": [ "target" ], "properties": { "target": { "title": "Target", "enum": [ "discoverByKeywords", "discoverFromUrls", "getCommunityProfile", "health" ], "type": "string", "description": "Choose one target for this run. Fields for other targets are ignored." }, "keywords": { "title": "Keywords", "minItems": 1, "type": "array", "description": "Enter one or more keywords or short phrases. The Actor finds matching public Skool communities.", "items": { "type": "string" } }, "discoveryUrls": { "title": "Public discovery URLs", "minItems": 1, "type": "array", "description": "Add one or more public Skool discovery or community page URLs. Discovery pages return listed communities. A community page returns that community profile.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Enter a public Skool discovery or community page URL.", "pattern": "^https?://" } }, "required": [ "url" ] } }, "communityUrlsOrIds": { "title": "Community URLs or IDs", "minItems": 1, "type": "array", "description": "Enter one or more public Skool community URLs or identifiers to retrieve their profiles.", "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "For Discover by keywords and Discover from public URLs, enter a category to limit discovery results. Leave it empty to include all categories. It does not filter a direct community page." }, "accessType": { "title": "Community access", "enum": [ "all", "free", "paid" ], "type": "string", "description": "For Discover by keywords and Discover from public URLs, choose all, free, or paid communities. The default is all communities. It does not change a direct community page.", "default": "all" }, "sortBy": { "title": "Discovery order", "enum": [ "popular", "trending" ], "type": "string", "description": "For Discover by keywords and Discover from public URLs, choose popular or trending results. The default is popular. It does not change a direct community page.", "default": "popular" }, "maxItems": { "title": "Maximum communities", "minimum": 1, "type": "integer", "description": "For Discover by keywords and Discover from public URLs, optionally stop each search after this many matched communities. Leave it empty to return all available results until each source is exhausted. It does not limit a direct community profile." } } }, "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 } } } } } } } } } }