{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register – Licensed Sponsors & Change Monitor", "description": "Search the Home Office register of licensed visa sponsors (Skilled Worker and all other routes) and get a feed of newly added and removed sponsors. Updated daily from GOV.UK. No API key.", "version": "1.0", "x-build-id": "QTs5jDqfvFi1qxPOf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ukdatakit~uk-visa-sponsor-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ukdatakit-uk-visa-sponsor-register", "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/ukdatakit~uk-visa-sponsor-register/runs": { "post": { "operationId": "runs-sync-ukdatakit-uk-visa-sponsor-register", "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/ukdatakit~uk-visa-sponsor-register/run-sync": { "post": { "operationId": "run-sync-ukdatakit-uk-visa-sponsor-register", "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", "changes" ], "type": "string", "description": "Search returns sponsors matching your filters. Changes compares today's register with the copy saved by your previous run and returns only sponsors that were added, removed or changed. Schedule it daily for a lead/alert feed.", "default": "search" }, "organisationNames": { "title": "Organisation names", "type": "array", "description": "Match sponsors whose name contains any of these words (case-insensitive), e.g. 'NHS', 'Deloitte'. Leave empty for all.", "items": { "type": "string" } }, "towns": { "title": "Towns / cities", "type": "array", "description": "e.g. London, Manchester. Leave empty for all.", "default": [ "London" ], "items": { "type": "string" } }, "routes": { "title": "Visa routes", "type": "array", "description": "Only sponsors licensed for at least one of these routes. Leave empty for all.", "items": { "type": "string", "enum": [ "Skilled Worker", "Global Business Mobility: Senior or Specialist Worker", "Global Business Mobility: Graduate Trainee", "Global Business Mobility: UK Expansion Worker", "Global Business Mobility: Service Supplier", "Global Business Mobility: Secondment Worker", "Scale-up", "Creative Worker", "Charity Worker", "Religious Worker", "Tier 2 Ministers of Religion", "International Sportsperson", "Government Authorised Exchange", "International Agreement", "Seasonal Worker" ] }, "default": [ "Skilled Worker" ] }, "ratings": { "title": "Ratings", "type": "array", "description": "A = fully compliant, B = on an action plan, Provisional = UK Expansion Worker. Leave empty for all.", "items": { "type": "string", "enum": [ "A", "B", "Provisional" ] } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Stop after this many records.", "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 } } } } } } } } } }