{ "openapi": "3.0.1", "info": { "title": "Skip Trace People Search", "description": "Find anyone in the US — phones, emails, addresses, relatives & aliases. Searches ThatsThem, Radaris & Spokeo simultaneously and merges results into one clean record. 4 search modes: name, phone, email, address.", "version": "1.0", "x-build-id": "cvjtMX1u7OIHfd6OL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~skip-trace-people-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-skip-trace-people-search", "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/brilliant_gum~skip-trace-people-search/runs": { "post": { "operationId": "runs-sync-brilliant_gum-skip-trace-people-search", "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/brilliant_gum~skip-trace-people-search/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-skip-trace-people-search", "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": [ "searchType" ], "properties": { "searchType": { "title": "Search Type", "enum": [ "name", "phone", "email", "address" ], "type": "string", "description": "How to search for the person.", "default": "name" }, "firstName": { "title": "First Name", "type": "string", "description": "Person's first name (for name search)." }, "lastName": { "title": "Last Name", "type": "string", "description": "Person's last name (for name search)." }, "state": { "title": "State", "type": "string", "description": "US state abbreviation to narrow results (for name/address search)." }, "city": { "title": "City", "type": "string", "description": "City to narrow results (for name/address search)." }, "phone": { "title": "Phone Number", "type": "string", "description": "Phone number to search (for phone search). Any format accepted." }, "email": { "title": "Email Address", "type": "string", "description": "Email address to search (for email search)." }, "street": { "title": "Street Address", "type": "string", "description": "Street address to search (for address search)." }, "zip": { "title": "ZIP Code", "type": "string", "description": "ZIP code (for address search)." }, "queries": { "title": "Batch Queries (JSON)", "type": "array", "description": "Array of query objects for batch mode. Each object should match the searchType fields. Example for name search: [{\"firstName\":\"John\",\"lastName\":\"Smith\",\"state\":\"NY\"}]. When provided, single-query fields above are ignored." }, "sources": { "title": "Data Sources", "type": "array", "description": "Which people search sites to query. Defaults to all 3 for maximum coverage.", "items": { "type": "string", "enum": [ "thatsThem", "radaris", "spokeo" ] }, "default": [ "thatsThem", "radaris", "spokeo" ] }, "maxResults": { "title": "Max Results Per Query", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of person records to return per search query.", "default": 5 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "US residential proxies are required — all 3 people search sites are US-geofenced and block datacenter IPs." } } }, "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 } } } } } } } } } }