{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register - Licensed Employers", "description": "The UK Home Office register of licensed Worker and Temporary Worker sponsors (143k registrations, OGL v3): organisation, town, county, type and rating (A/B), and sponsored route. Search by name, town, county or route; aggregate; or get the latest daily change feed.", "version": "0.0", "x-build-id": "zg4JCmwodJiDTvSLn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~uk-visa-sponsors/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-uk-visa-sponsors", "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/j0401~uk-visa-sponsors/runs": { "post": { "operationId": "runs-sync-j0401-uk-visa-sponsors", "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/j0401~uk-visa-sponsors/run-sync": { "post": { "operationId": "run-sync-j0401-uk-visa-sponsors", "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", "properties": { "mode": { "title": "Mode", "enum": [ "", "search", "aggregate", "changes" ], "type": "string", "description": "search = filter the register. aggregate = one row per group. changes = new, removed and rating-changed registrations vs the previous daily snapshot. Leave blank to auto-route: filters -> search, no filters -> aggregate." }, "name": { "title": "Organisation name", "type": "string", "description": "Organisation name substring, case-insensitive (e.g. \"TESCO\" or \"NHS\")." }, "town": { "title": "Town / city", "type": "string", "description": "Exact town or city, case-insensitive (e.g. \"London\", \"Manchester\")." }, "county": { "title": "County", "type": "string", "description": "Exact county, case-insensitive (e.g. \"Surrey\", \"West Midlands\"). Use \"(not stated)\" for rows with no county." }, "route": { "title": "Sponsored route", "type": "string", "description": "Exact route, e.g. \"Skilled Worker\", \"Creative Worker\", \"Charity Worker\", \"Global Business Mobility: Senior or Specialist Worker\"." }, "rating": { "title": "Rating", "enum": [ "", "A", "B" ], "type": "string", "description": "Exact rating: A (full licence) or B (sponsor action plan). Leave blank for all." }, "workerType": { "title": "Worker type", "type": "string", "description": "Exact worker type, e.g. \"Worker\" or \"Temporary Worker\"." }, "typeRating": { "title": "Type and rating (raw)", "type": "string", "description": "Exact raw value, e.g. \"Worker (A rating)\" or \"Worker (UK Expansion Worker: Provisional )\"." }, "groupBy": { "title": "Aggregate by", "enum": [ "", "route", "rating", "workerType", "typeRating", "county" ], "type": "string", "description": "route -> Skilled Worker vs other routes; rating -> A vs B; workerType -> Worker vs Temporary Worker; typeRating -> raw type and rating; county -> sponsor county. Blank defaults to route." }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of search records pushed (0 = the default ceiling of 50, maximum 5000). Aggregate and changes return every row.", "default": 50 } } }, "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 } } } } } } } } } }