{ "openapi": "3.0.1", "info": { "title": "Zillow Message Inbox Export - Rental & Buying Chats", "description": "Export both Zillow inboxes (rental & buying) with full message history. Extract conversations to JSON for CRM, legal, or archival. $35/month unlimited. Built for property managers and agents.", "version": "0.0", "x-build-id": "bCJtclijHYPFOZEkV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~zillow-message-inbox-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-zillow-message-inbox-api", "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/clearpath~zillow-message-inbox-api/runs": { "post": { "operationId": "runs-sync-clearpath-zillow-message-inbox-api", "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/clearpath~zillow-message-inbox-api/run-sync": { "post": { "operationId": "run-sync-clearpath-zillow-message-inbox-api", "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": [ "mode" ], "properties": { "email": { "title": "Email (Auto-Login - Recommended)", "type": "string", "description": "Your Zillow account email. Provide email + password to automatically login and receive cookies. Cookies will be stored and reused across runs until they expire.\n\nThis is the recommended authentication method - simpler and more reliable than manual cookies." }, "password": { "title": "Password", "type": "string", "description": "Your Zillow account password. Required if email is provided.\n\nNote: Your password is transmitted securely and never stored. Only session cookies are saved for future runs." }, "cookies": { "title": "Zillow Cookies (Manual Method - Optional)", "type": "string", "description": "Alternative to email/password: Provide Zillow authentication cookies manually. Supports three formats:\n\n1) Browser extension JSON array: \"[{\\\"name\\\":\\\"zgsession\\\",\\\"value\\\":\\\"1|abc123\\\",\\\"domain\\\":\\\".zillow.com\\\"},...]\" - Install 'Cookie-Editor' extension, click Export → JSON\n\n2) Browser cookie string: \"zgsession=1|abc123; loginmemento=1|xyz789; _px3=...; ZILLOW_SID=1|...; zjs_user_id=...\"\n\n3) JSON object: {\"zgsession\": \"1|abc123\", \"loginmemento\": \"1|xyz789\", \"_px3\": \"...\", \"ZILLOW_SID\": \"1|...\", \"zjs_user_id\": \"...\"}\n\nRequired cookies: zgsession, loginmemento, _px3, ZILLOW_SID, zjs_user_id\n\nNote: Auto-login (email/password) is recommended over manual cookies." }, "mode": { "title": "Inbox Type", "enum": [ "rental", "buying", "both" ], "type": "string", "description": "Select which inbox conversations to fetch:\n\n• Rental Hub Inbox: Fetch rental conversations (property managers, landlords)\n• Buying Inbox: Fetch buying conversations (real estate agents, sellers)\n• Both: Fetch both rental and buying conversations", "default": "rental" }, "fetchFullConversations": { "title": "Fetch Full Conversation History", "type": "boolean", "description": "When enabled, fetches complete message history for each conversation. This makes additional API calls (one per conversation) and significantly increases runtime.\n\nDisabled: Returns only conversation previews (fast, default behavior)\nEnabled: Returns all messages in each conversation (slower, more complete data)\n\nNote: Applies to both Rental Hub Inbox and Buying Inbox conversations.", "default": 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 } } } } } } } } } }