{ "openapi": "3.0.1", "info": { "title": "Massachusetts CSL License Lookup & Verify", "description": "Look up Massachusetts CSL records by license number or last name. See state-listed status, license type, dates, and limited location fields from the public DOL/OPSI registry.", "version": "1.0", "x-build-id": "c4t9qGG1hJrUfZDzc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~massachusetts-construction-license-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-massachusetts-construction-license-lookup", "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/muhammadafzal~massachusetts-construction-license-lookup/runs": { "post": { "operationId": "runs-sync-muhammadafzal-massachusetts-construction-license-lookup", "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/muhammadafzal~massachusetts-construction-license-lookup/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-massachusetts-construction-license-lookup", "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": [ "queries" ], "properties": { "queries": { "title": "License numbers or last names", "minItems": 1, "maxItems": 10, "uniqueItems": true, "type": "array", "description": "Use one to ten values to search. For licenseNumber mode, enter a CSL number such as CS-067262; full numbers give the narrowest match. For lastName mode, enter a surname such as Smith. This searches CSL records only, not Home Improvement Contractor registrations.", "items": { "type": "string", "minLength": 2, "maxLength": 50 }, "default": [ "CS-067262" ] }, "searchMode": { "title": "Search by", "enum": [ "licenseNumber", "lastName" ], "type": "string", "description": "Use licenseNumber for a full or partial Massachusetts CSL number, or lastName for an individual's surname. The lastName mode can return multiple licensees and is bounded by Maximum results.", "default": "licenseNumber" }, "licenseType": { "title": "CSL license type", "enum": [ "any", "unrestricted", "oneTwoFamily", "specialty" ], "type": "string", "description": "Use any to check all three Construction Supervisor License types. Choose a specific type to narrow the state search. This does not search other Massachusetts trades or HIC registrations.", "default": "any" }, "licenseStatus": { "title": "License status filter", "enum": [ "any", "Active", "Active - Non-compliant", "Active (Valor Act)", "Active by Executive Order", "CO Issued", "Decommission", "Do Not Renew", "Exam Failed", "Exam No Show", "Exam Passed", "Exempt", "Expired", "Expired - Not Renewable", "Inactive", "Inactive - Business Closed", "Null and Void", "Pending", "Pending Active Renewal", "Pending Expired Renewal", "Probation", "Reinstatement Pending", "Renewal - Incomplete", "Retired", "Revoked", "Same As Main", "Suspended", "Tank Removed", "Transfer Pending" ], "type": "string", "description": "Use any to include every state-listed status, or select one status to filter the registry results. The Actor reports the source status and does not issue a certified verification letter.", "default": "any" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50, "type": "integer", "description": "Use this to cap returned license records and result-event charges. Default 20; maximum 50. Free-plan runs are capped at 5 records even when a higher value is entered.", "default": 20 }, "includeDetails": { "title": "Fetch license details", "type": "boolean", "description": "Use true to fetch issue, expiration, renewal, licensee name, and city/state/ZIP details from each state result page. Street address and gender are not included. Use false for a faster search with listing fields only.", "default": true } } }, "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 } } } } } } } } } }