{ "openapi": "3.0.1", "info": { "title": "Skool Api", "description": "Complete Skool API for reading and managing communities, members, posts, comments, classroom, courses, events, files, notifications, and admin workflows. Supports 40+ actions for Skool automation. Use your authenticated Skool session to automate repetitive tasks and access data through one API.", "version": "0.0", "x-build-id": "8DWXxHj7xccb3xmjx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/skyline_scrapers~skool-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-skyline_scrapers-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/skyline_scrapers~skool-api/runs": { "post": { "operationId": "runs-sync-skyline_scrapers-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/skyline_scrapers~skool-api/run-sync": { "post": { "operationId": "run-sync-skyline_scrapers-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": [ "action" ], "properties": { "action": { "title": "API Action", "enum": [ "auth:login", "posts:list", "groups:getCategories", "posts:get", "posts:create", "posts:createComment", "posts:update", "posts:delete", "system:health", "files:uploadImage", "posts:pin", "posts:unpin", "members:pending", "members:approve", "members:reject", "members:ban", "members:unban", "members:batchApprove", "classroom:listCourses", "classroom:getTree", "classroom:createCourse", "classroom:createFolder", "classroom:createPage", "classroom:setBody", "classroom:updateCourse", "classroom:deleteUnit", "classroom:markDone", "files:uploadFile", "posts:vote", "posts:getComments", "groups:get", "members:list", "members:export", "events:list", "social:follow", "social:unfollow", "classroom:updateResources", "notifications:markAllRead", "auth:initEmailVerification", "auth:confirmEmailVerification" ], "type": "string", "description": "Choose the action you want to perform.\n\nSupports 40+ actions for authentication, posts, comments, members, classroom, courses, files, events, notifications, and admin workflows.\n\n💡 First time? Run auth:login, save the returned cookies, then use those cookies for future requests.\n\nSome actions require Community Admin or Owner permissions.", "default": "system:health" }, "email": { "title": "Account Email", "type": "string", "description": "Email address used to sign in to your Skool account. Required only for auth:login." }, "password": { "title": "Skool Password", "type": "string", "description": "Password for your Skool account. Required only for auth:login." }, "cookies": { "title": "Cookies (from a previous auth:login)", "type": "string", "description": "Paste the cookies returned by a previous auth:login run. Using cookies skips the login step and makes future requests faster and more reliable." }, "otpCode": { "title": "Verification Code (OTP)", "type": "string", "description": "Optional one-time verification code sent by Skool during login. Usually only needed when Skool requests email verification." }, "interactiveOtp": { "title": "Interactive OTP Prompt", "type": "boolean", "description": "For local development only. Pauses the login process and lets you enter the verification code interactively. Has no effect on Apify cloud runs." }, "groupSlug": { "title": "Skool Community", "type": "string", "description": "Community slug from https://www.skool.com/{community}. Required for most community and admin actions." }, "params": { "title": "Action Parameters", "type": "object", "description": "JSON parameters for the selected action.\n\nEach action accepts different parameters. Provide only the fields required for your chosen action.\n\nExamples:\n• posts:list → {\"page\":1}\n• posts:get → {\"postId\":\"...\"}\n• posts:create → {\"title\":\"...\",\"content\":\"...\"}\n• classroom:createCourse → {\"title\":\"My Course\"}\n• members:approve → {\"memberId\":\"...\"}\n\nSee the README for complete parameter documentation and examples." }, "debug": { "title": "Debug Login", "type": "boolean", "description": "Save additional screenshots and HTML during auth:login for troubleshooting login issues. Disable for normal use.", "default": false } } }, "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 } } } } } } } } } }