Zillow Message Inbox API 💬

Pricing

$35.00/month + usage

Zillow Message Inbox API 💬

Export both Zillow inboxes (rental & buying) programmatically. Extract your conversations with full message history in seconds. CRM integration, legal documentation, archival. Cookie authentication. Structured JSON output. $35/month unlimited extractions. Property managers & agents.

Pricing

$35.00/month + usage

Rating

0.0

(0)

Developer

ClearPath

Maintained by Community

Actor stats

Bookmarked

Total users

Monthly active users

a month ago

Last modified

Categories

Real estate

Automation

Lead generation

You can access the Zillow Message Inbox API 💬 programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

Python

JavaScript

CLI

OpenAPI

HTTP

MCP

{
  "openapi": "3.0.1",
  "info": {
    "version": "0.0",
    "x-build-id": "Ga4FKFPcx8sNlRBXy"
  },
  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Zillow Message Inbox API 💬 OpenAPI definition

OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.

OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.

By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.

You can download the OpenAPI definitions for Zillow Message Inbox API 💬 from the options below:

OpenAPI.json

If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.

You can also check out our other API clients:

Zillow Message Inbox API 💬 API in Python

Zillow Message Inbox API 💬 API in JavaScript

Zillow Message Inbox API 💬 API through CLI

Zillow Message Inbox API 💬 API

Zillow Property Details Scraper

scrapeverse/zillow-property-details-scraper

Extract comprehensive property details from Zillow URLs quickly and easily with our Zillow Property Details Scraper. Accurate data in seconds!

ScrapeVerse

227

Zillow Agents Finder

jupri/zillow-agents

💫 Scrape Zillow.com Agents

cat

409

3.3

Zillow Property Data Scrape

macrosmovie/zillow-property-data-scrape

Scrape zillow property data by address

MacroMovie MacrosS

Zillow Agent Rental Listings Scraper

zillowscraper/zillow-agent-rental-listings-scraper

Scrape rental listings from Zillow agents with property details like price, address, and size. Great for market analysis, data aggregation, or real estate automation tools.

Zillow Scraper

Zillow Real State Agents Scraper

getdataforme/zillow-real-state-agents-scraper

The Zillow Real Estate Agents Scraper Actor enables you to extract detailed information about real estate agents from Zillow's platform. The actor provides structured data about agents, including their profiles, ratings, and sales history, which can be downloaded JSON, CSV, Excel, or XML formats.

GetDataForMe

155

4.6

Zillow Property Details Scraper

coder_luffy/zillow-property-details-scraper

Zillow Property Details Scraper lets you instantly extract complete real estate data from Zillow. Get accurate property pricing, location insights, features, photos, and market trends in one click. Ideal for investors, agents, and analysts seeking fast, reliable data.

Luffy

Zillow Property Lookup

danek/zillow-property-lookup

Extract properties details by Zillow property id or url

Jan Danecki

Zillow Price History Scraper

powerai/zillow-price-history-scraper

Scrape property price history from Zillow, including sale prices, price changes, and market trends.

PowerAI

5.0

Zillow Property Managers/Owners Scraper [$0.85/ 1K]

memo23/apify-zillow-property-managers-cheerio

Effortlessly gather detailed insights on Zillow property managers – streamline your data collection and make informed decisions.

Muhamed Didovic

Zillow (Find a Property Managers) 🏢👨‍💼👩‍💼

scrapestorm/zillow-find-a-property-managers

Unlock the power of Zillow with automated agent profile scraping – effortlessly gather key insights and data on property managers, with the ability to customize your advanced queries! 👨‍💼📈🔍💻🚀👩‍💼 No need for proxy!