{ "openapi": "3.0.1", "info": { "title": "Club OS API Gym CRM & Lead Management", "description": "Gym CRM & Lead Management - Sales Pipeline, Members & Conversions Access Club OS data for fitness clubs & gyms. Get leads, members, sales pipeline, tasks, appointments & communication history. Ideal for gym sales teams, franchise operations, & fitness club management.", "version": "1.5", "x-build-id": "uOI7rskZoQzW2smgI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~club-os-api-gym-crm-lead-management/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-club-os-api-gym-crm-lead-management", "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/alizarin_refrigerator-owner~club-os-api-gym-crm-lead-management/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-club-os-api-gym-crm-lead-management", "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/alizarin_refrigerator-owner~club-os-api-gym-crm-lead-management/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-club-os-api-gym-crm-lead-management", "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": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "get_leads", "get_members", "get_staff", "get_appointments", "get_clubs", "get_tasks", "get_sales_pipeline", "get_reports" ], "type": "string", "description": "get_leads, get_members, get_staff, get_appointments and get_clubs use Club OS API V3 (apiKey). get_tasks (follow-ups), get_sales_pipeline (sales events) and get_reports (KPIs) use Club OS API V2 (apiUsername + apiPassword).", "default": "get_leads" }, "apiKey": { "title": "API V3 key", "type": "string", "description": "Your own Club OS API V3 key (request it from support@club-os.com or your Club OS Account Manager). Sent in the X-API-Key header. Used by get_leads, get_members, get_staff, get_appointments and get_clubs. If no credentials are given, the actor returns clearly labeled sample data and charges no task event." }, "apiUsername": { "title": "API V2 username", "type": "string", "description": "Your own Club OS API V2 username (issued by support@club-os.com). Used by get_tasks, get_sales_pipeline and get_reports." }, "apiPassword": { "title": "API V2 password", "type": "string", "description": "Your own Club OS API V2 password. Exchanged for a 24-hour token at the start of the run." }, "clubId": { "title": "Club ID", "type": "string", "description": "Your numeric Club OS club id. Required by every task except get_clubs (run get_clubs to list the clubs your key can access)." }, "locationId": { "title": "Location ID", "type": "string", "description": "Optional numeric Club OS location id. Required for get_tasks and get_sales_pipeline. Run get_clubs with a clubId to list its locations." }, "startDate": { "title": "Start Date", "type": "string", "description": "Optional YYYY-MM-DD (UTC). get_leads and get_members: created on or after. get_appointments, get_tasks, get_sales_pipeline, get_reports: start of the period (default: 30 days ago)." }, "endDate": { "title": "End Date", "type": "string", "description": "Optional YYYY-MM-DD (UTC), inclusive. End of the period (default: today, or 30 days from today for get_appointments)." }, "limit": { "title": "Limit", "minimum": 1, "type": "integer", "description": "Maximum number of records to return. API V3 tasks page through results (up to 1000 per request). API V2 tasks return at most 1000 records.", "default": 100 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to receive results via webhook" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Return labeled sample data instead of calling Club OS. Sample data is also returned automatically when no credentials are given. Sample runs charge no task event.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }