{ "openapi": "3.0.1", "info": { "title": "💬 LinkedIn Conversation Scraper", "version": "0.1", "x-build-id": "s7u5gkYknCwN8JqcP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeengine~linkedin-conversation-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeengine-linkedin-conversation-scraper", "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/scrapeengine~linkedin-conversation-scraper/runs": { "post": { "operationId": "runs-sync-scrapeengine-linkedin-conversation-scraper", "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/scrapeengine~linkedin-conversation-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeengine-linkedin-conversation-scraper", "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": [ "li_at" ], "properties": { "list_type": { "title": "📥 Inbox Type", "enum": [ "PRIMARY_INBOX", "INBOX", "SECONDARY_INBOX", "ARCHIVE", "SPAM" ], "type": "string", "description": "Which inbox to scrape when no URLs are provided.", "default": "PRIMARY_INBOX" }, "filter": { "title": "🔎 Conversation Filter", "enum": [ "", "INMAIL", "STARRED", "firstDegreeConnections:true", "read:false" ], "type": "string", "description": "Optional filter applied to the inbox list.", "default": "" }, "li_at": { "title": "🔐 LinkedIn Session Cookie (li_at)", "type": "string", "description": "Your `li_at` cookie from www.linkedin.com. Required for authentication. Open LinkedIn in your browser → DevTools → Application → Cookies → www.linkedin.com → copy the `li_at` value. ⚠️ Never share this cookie publicly — treat it like a password." }, "max_convs": { "title": "💬 Maximum Conversations", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum number of conversations to scrape. Set `0` for no limit. Higher values = longer runs.", "default": 10 }, "max_messages_per_conv": { "title": "📝 Maximum Messages per Conversation", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum number of messages to extract from each conversation. Set `0` for no limit.", "default": 5 }, "today_limit": { "title": "📅 Only Today's Conversations", "type": "boolean", "description": "If enabled, only conversations with activity **today** are included.", "default": false }, "date_limit": { "title": "🗓️ Date Limit (YYYY-MM-DD)", "type": "string", "description": "Skip conversations older than this date. Leave empty for no date limit." }, "enrich_profiles": { "title": "✨ Enrich Participant Profiles", "type": "boolean", "description": "If enabled, visits each participant's profile page to extract **headline**, **distance** (1st/2nd/3rd), and **pronouns**. Slower but produces richer output.", "default": true }, "proxyConfiguration": { "title": "🌐 Proxy Configuration", "type": "object", "description": "Configure Apify proxy usage for this run. Leave off for direct connection unless you need a fixed proxy.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }