Developers

Quickstart: the whole journey

Take a property from submission to an accepted offer, in the same steps the app walks you through.

1
Get your API key
Open Settings → API in the Zoodealio app and generate a key. It is shown once, so keep it in a secret manager or an environment variable, never in code.
Shell
```
export ZOODEALIO_API_KEY="zoo_…"
```

2

Subscribe to webhooks

Zoodealio tells you when each step finishes, so you never poll. transaction.stage_changed covers every step; the others mark the moments you act on.

Shell

curl -X POST "https://api.zoodealio.ai/openapi/Webhooks" \
  -H "ApiKey: $ZOODEALIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"endpointUrl":"https://you.example/zoodealio","eventTypes":["transaction.stage_changed","offer.created","property.files_imported","comping.completed","comping.failed","offer.details_shared","offer.accepted"]}'

3

Submit the property

Send the address, the home’s details and the homeowner. Photos and documents ride along as URLs you host, as many as the listing has; Zoodealio imports them in the background. The property is priced on the spot and gets an estimated offer (offer.created).

Shell

curl -X POST "https://api.zoodealio.ai/openapi/Properties" \
  -H "ApiKey: $ZOODEALIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":{"addressLine1":"102 Shore Drive","city":"Youngsville","stateCode":"LA","postalCode":"70592","country":"US"},"attributes":{"bedroomCount":4,"bathroomCount":2.5,"squareFootage":2400,"yearBuilt":2016},"homeowner":{"email":"jane.doe@example.com","fName":"Jane","lName":"Doe","phone":"+15551234567"},"photos":[{"url":"https://cdn.example.com/102-shore/front.jpg"}]}'

Then wait for property.files_imported

4
Show the estimate
Read the property’s offers. The estimate is kind: "Estimated" and carries only its range, estimatedRange: { low, high }. Keep its id for the next step.
Shell
```
curl "https://api.zoodealio.ai/openapi/Offers?propertyId=$PROPERTY_ID" \
  -H "ApiKey: $ZOODEALIO_API_KEY"
```
5
Accept the estimate: confirm details and start AI comping
Accepting the estimate asks for real offers and starts AI comping. Before you do, have the homeowner confirm the home’s details and send them with it. Photos should already be in: send more first with POST /openapi/Properties/{id}/photos and wait for property.files_imported. Both are optional: accept with no body at all to skip them.
Shell
```
curl -X POST "https://api.zoodealio.ai/openapi/Offers/$ESTIMATE_ID/accept" \
  -H "ApiKey: $ZOODEALIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"attributes":{"bedroomCount":4,"bathroomCount":3,"squareFootage":2450,"yearBuilt":2016}}'
```
Then wait for comping.completed
6
Show the offers
When comping completes, read the offers again. Each real offer is kind: "Actual" with its headline amount; its terms stay null until the next step. revealUrl on the comping status opens the full reveal in the app.
Shell
```
curl "https://api.zoodealio.ai/openapi/Offers?propertyId=$PROPERTY_ID" \
  -H "ApiKey: $ZOODEALIO_API_KEY"
```
7
Request the details
Ask for the full terms of the offer the homeowner is interested in. Zoodealio finalizes it and shares the details.
Shell
```
curl -X POST "https://api.zoodealio.ai/openapi/Offers/$OFFER_ID/request-details" \
  -H "ApiKey: $ZOODEALIO_API_KEY"
```
Then wait for offer.details_shared
8
Accept the offer
Read the offer to show its full terms, then accept it. The transaction moves to OfferSelected and contracting continues in the app.
Shell
```
curl -X POST "https://api.zoodealio.ai/openapi/Offers/$OFFER_ID/accept" \
  -H "ApiKey: $ZOODEALIO_API_KEY"
```
Then wait for offer.accepted

Journey stages

A transaction's stage moves through these in order. Every change arrives as transaction.stage_changed.

Stage	Moved by	What it means
EstimatedOfferAvailable	You	Property submitted and priced; the estimate is ready.
OfferRequested	You	Estimate accepted; AI comping is starting.
CompingQueued	Zoodealio	AI comping is queued.
CompingInProgress	Zoodealio	AI comping is running.
CompingComplete	Zoodealio	Real offers are ready (`comping.completed`).
CompingViewed	The app	Someone opened the offer reveal.
DetailsRequested	You	Full details requested.
OfferReady	Zoodealio	The offer is finalized.
DetailsShared	Zoodealio	Full terms are readable (`offer.details_shared`).
OfferSelected	You	Offer accepted (`offer.accepted`).

For AI agents

Everything an AI assistant needs to build on Zoodealio without guessing. None of it needs a key.

Docs for LLMs

The whole reference as one Markdown file. Paste the link into a chat, or point your agent at it.

https://zoodealio.ai/developers/llms-full.txt

Open in ChatGPT llms.txt index

Docs MCP server

Lets your coding assistant search these docs and read exact paths and fields.

claude mcp add --transport http --scope user zoodealio-docs https://zoodealio.ai/developers/mcp

Account MCP server

A separate server on the API host that acts as you, with your API key. Its tools are API calls, so an AI assistant takes the same steps: submit a property and its photos, accept the estimate to request AI comping, request details and accept an offer, and manage the team.

https://api.zoodealio.ai/openapi/mcp

Set up Claude, Cursor or VS Code

Agent skills

SKILL.md files that teach a coding assistant how to build on Zoodealio correctly. Install them all for Claude Code with one command, or download one (Cursor: ~/.cursor/skills/<name>/SKILL.md, Copilot: ~/.copilot/skills/<name>/SKILL.md).

for s in zoodealio-api zoodealio-webhooks zoodealio-offers; do mkdir -p ~/.claude/skills/$s && curl -fsSL "https://zoodealio.ai/developers/skills/$s/SKILL.md" -o ~/.claude/skills/$s/SKILL.md; done

zoodealio-api

Build integrations against the REST API: auth, the journey from property to accepted offer, and the rules that cause most bugs.

SKILL.md

zoodealio-webhooks

Receive webhooks safely: signature verification in Node and Python, retries, dedupe.

SKILL.md

zoodealio-offers

For AI assistants connected to the Zoodealio MCP server: take a property from estimate to accepted offer.

SKILL.md

Getting started

Every endpoint is listed as a full URL against this environment's API host. Requests and responses are JSON, and photos and documents are sent as URLs.

Base URL

https://api.zoodealio.ai/openapi

Example request

curl "https://api.zoodealio.ai/openapi/Properties?page=1&pageSize=20" \
  -H "ApiKey: zoo_your_key_here"

curl "https://api.zoodealio.ai/openapi/Offers?propertyId=5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a" \
  -H "ApiKey: zoo_your_key_here"

One base URL

Every request goes to the same API host under /openapi/<Resource>. There is one version of the API: no version segments and no duplicate routes. The only other URLs involved are your own webhook endpoints, which Zoodealio calls back.

Authentication

Send your API key in the ApiKey header on every request (Authorization: Bearer <key> also works). Keys look like zoo_… and are shown exactly once when generated or rotated, on Settings → API. The key belongs to you and uses your current role, team memberships and assignments, just like the app.

The same actions as the app

The API does what you can do in the app, and nothing more: submit and edit properties, add photos and documents, accept an estimate to start AI comping, request an offer’s details and accept an offer. Offers are made by Zoodealio, so they cannot be created or edited through the API.

What you see, and when

The same gate as the app. An estimate shows only its range. A real offer shows its headline amount once AI comping completes, and its full terms once you request details and they are shared. Internal notes, valuation evidence and comparable sales are never returned.

Teams and workspace moves

Owners and account admins have workspace access. Team admins have access through the teams they administer and every team below them. Members have access to their own homeowners and properties. Your key and webhook subscriptions stay with you when you move workspaces, and access is recalculated from your current workspace, including before each webhook delivery.

Ids in the path, not the body

Every update and delete addresses its record through the URL, e.g. PUT /openapi/Properties/{id}. Sending the id in the body against the collection path instead returns 405 Method Not Allowed, because the collection has no PUT.

Rate limiting

Requests over the limit return 429 Too Many Requests with a Retry-After header telling you how long to back off.

Errors

Failures come back as application/problem+json with a title and detail: 400 for validation, 401 for a bad key, 403 for an action your role cannot perform, 404 for a record outside your current scope, 409 for a conflict (a duplicate address, or a step taken out of order).

Status codes

Failures are application/problem+json with a title and detail. What each status means and what to do about it:

Status	Meaning	What to do
200 / 201	Success.	Read the JSON body; a create returns the new `id`.
204	Success with no body.	Nothing to read.
400	Validation failed.	Fix the fields named in the problem `detail`; do not retry unchanged.
401	Missing or invalid API key.	Send `ApiKey`; rotate the key if it leaked.
403	Your role cannot do this.	Use a key whose owner has the permission.
404	Not found, or outside your current access.	Check the id and that the record belongs to someone you can see.
405	Wrong method for this path.	Put the id in the path, e.g. `PUT /openapi/Properties/{id}`.
409	Conflict: a duplicate address, a stale `If-Match`, or a step taken out of order.	Re-read the transaction’s `stage` and take the step it is waiting for.
413	Upload too large.	A multipart upload over about 4 MB. Send the files as URLs instead.
429	Rate limited.	Wait the number of seconds in `Retry-After`, then retry.

Properties

The core record. Submit a property with its homeowner, photos and documents, edit its details, and manage its files. Everything else hangs off a property.

Good to know

Submitting a property prices it straight away: it is born with its transaction and an estimated offer, exactly like one submitted in the app. The offer.created webhook tells you the estimate is ready.
Attach the homeowner inline with homeowner (email, fName, lName, phone), or pass homeownerId to reuse one you already created (every property returns its homeownerId). Send one or the other, not both. A new homeowner is notified and invited to their portal.
agentId picks the agent the property belongs to; omit it and it is yours. A second property at an address an agent already holds is a 409.
Send files as URLs you host (photos: [{ url, label }], documents: [{ url, fileName }]). They can ride along with the submission, or be added any time with POST /openapi/Properties/{id}/photos and /documents. Up to 200 files per import, so a full listing goes in one call.
Files import in the background. The request answers at once with an importId and a statusUrl (202, or inside the 201 of a submission), and the property.files_imported webhook fires when every file is done.
The webhook and the status endpoint carry the same result: the saved photoIds and documentIds, and failed: [{ source, reason }] for each file that was not saved (a 404, not an image, too large). A failed file never fails the import. Send it again, fixed or on its own.
The URLs must be public HTTPS and serve the file itself; a short-lived signed link works well, as long as it outlives the import (a few minutes for a big set). Zoodealio fetches each file once and keeps its own copy.
Photos are JPEG, PNG or WebP, up to 10 MB each, and are stored at 2000 px on the long edge. More photos mean a more confident AI valuation; five or more is a good target.
Documents are PDF, Word, Excel, PowerPoint, RTF, text, CSV or images, up to 25 MB each from a URL. They appear on the property’s Documents tab in the app. You can delete the documents you uploaded.
A few local files can be uploaded directly instead: multipart/form-data to /photos or /documents, saved during the request. A request carries only about 4 MB, so URLs are the way to send more than a file or two.
PUT replaces address and attributes wholesale. If-Match is optional: send the ETag from a GET to reject a stale write.
List filters: search (free text over the address), stateCode, page, pageSize.

Examples

POST /openapi/Properties: request

{
  "address": {
    "addressLine1": "102 Shore Drive",
    "addressLine2": "",
    "city": "Youngsville",
    "stateCode": "LA",
    "postalCode": "70592",
    "country": "US"
  },
  "attributes": {
    "bedroomCount": 4,
    "bathroomCount": 2.5,
    "squareFootage": 2400,
    "yearBuilt": 2016
  },
  "homeowner": {
    "email": "jane.doe@example.com",
    "fName": "Jane",
    "lName": "Doe",
    "phone": "+15551234567"
  },
  "photos": [
    { "url": "https://cdn.example.com/listings/102-shore/front.jpg", "label": "Front" },
    { "url": "https://cdn.example.com/listings/102-shore/kitchen.jpg", "label": "Kitchen" }
  ],
  "documents": [
    { "url": "https://cdn.example.com/listings/102-shore/disclosure.pdf" }
  ]
}

201 Created: response (Location header carries the new property URL)

{
  "id": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "homeownerId": "8a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "importId": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "importStatusUrl": "/openapi/Properties/5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a/imports/7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
}

GET /openapi/Properties/{id}: response

{
  "id": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "address": {
    "addressLine1": "102 Shore Drive",
    "addressLine2": "",
    "city": "Youngsville",
    "stateCode": "LA",
    "postalCode": "70592",
    "country": "US"
  },
  "attributes": {
    "bedroomCount": 4,
    "bathroomCount": 2.5,
    "squareFootage": 2400,
    "yearBuilt": 2016
  },
  "latitude": 30.108,
  "longitude": -91.987,
  "agentId": "3f6c1a2e-9b4d-4c1f-8a2b-1d2e3f4a5b6c",
  "homeownerId": "8a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "createdAt": "2026-09-24T12:00:00Z",
  "updatedAt": "2026-09-24T12:00:00Z",
  "eTag": "\"0x8DCB…\"",
  "activeTransactionId": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"
}

PUT /openapi/Properties/{id}: request

{
  "address": {
    "addressLine1": "102 Shore Drive",
    "addressLine2": "",
    "city": "Youngsville",
    "stateCode": "LA",
    "postalCode": "70592",
    "country": "US"
  },
  "attributes": {
    "bedroomCount": 4,
    "bathroomCount": 3,
    "squareFootage": 2450,
    "yearBuilt": 2016
  }
}

POST /openapi/Properties/{id}/photos: request

{
  "photos": [
    { "url": "https://cdn.example.com/listings/102-shore/front.jpg", "label": "Front" },
    { "url": "https://cdn.example.com/listings/102-shore/kitchen.jpg", "label": "Kitchen" }
  ]
}

202 Accepted: response (the same for photos and documents)

{
  "importId": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "statusUrl": "/openapi/Properties/5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a/imports/7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
}

POST /openapi/Properties/{id}/documents: request

{
  "documents": [
    { "url": "https://cdn.example.com/listings/102-shore/disclosure.pdf" },
    { "url": "https://files.example.com/dl?id=8812", "fileName": "inspection.pdf" }
  ]
}

A few local files instead: multipart, saved during the request (about 4 MB)

curl -X POST "https://<services-host>/openapi/Properties/$id/photos" \
  -H "ApiKey: $ZOODEALIO_API_KEY" \
  -F "photos=@front.jpg" \
  -F "photos=@kitchen.jpg"

GET /openapi/Properties/{id}/imports/{importId}: response

{
  "importId": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "status": "completed",
  "total": 62,
  "processed": 62,
  "photoIds": ["c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f", "…"],
  "documentIds": ["e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b"],
  "failed": [
    {
      "source": "https://cdn.example.com/listings/102-shore/kitchen.jpg",
      "reason": "The URL answered 404."
    }
  ]
}

GET /openapi/Properties/{id}/documents: response

[
  {
    "id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b",
    "fileName": "disclosure.pdf",
    "size": 482113,
    "contentType": "application/pdf",
    "url": "https://…/property-documents/5d4c…/e5f6….pdf",
    "uploadedByUserId": "3f6c1a2e-9b4d-4c1f-8a2b-1d2e3f4a5b6c",
    "uploader": {
      "userId": "3f6c1a2e-9b4d-4c1f-8a2b-1d2e3f4a5b6c",
      "fName": "Alex",
      "lName": "Smith",
      "email": "alex.smith@example.com"
    },
    "createdAt": "2026-09-24T12:00:00Z"
  }
]

GET /openapi/Properties/{id}/photos: response

[
  {
    "id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",
    "url": "https://…/property-photos/5d4c…/c4d5….webp",
    "expiresAt": "2026-09-24T13:00:00Z",
    "order": 0,
    "createdAt": "2026-09-24T12:00:00Z",
    "label": "Front"
  }
]

Offers

Read a property’s offers and take the two actions the app gives you: accept an offer, and request an offer’s full details.

Good to know

There are two kinds of offer. kind: "Estimated" is the instant estimate a property gets on submission; kind: "Actual" is a real offer produced by AI comping.
An estimated offer only ever returns its range: estimatedRange: { low, high }. amount and every terms block are null, just as the app shows a range and nothing more.
An actual offer shows its headline amount as soon as it exists. Its terms (cashOffer, cashOfferPlus, sellNowMoveLater, listOnMarket) stay null until you request details and they are shared (detailsShared: true), the same gate as the app.
Accepting an estimated offer is how you ask for real offers: it starts AI comping. In the same request you can confirm the home’s details (attributes); send no body to skip it. Photos are not sent here: import them first with POST /openapi/Properties/{id}/photos and accept once property.files_imported arrives, so comping starts with them.
Accepting an actual offer selects it. Its details must be shared first (otherwise 409 or 422). Accept takes no body for an actual offer.
Both actions return the transaction, so you can see the step it moved to. Their optional If-Match is the transaction’s ETag, not the offer’s.
request-details asks for the offer’s full terms. It returns the transaction; the terms arrive later with the offer.details_shared webhook, then read the offer again.
Steps must happen in order. Accepting or requesting at the wrong step is a 409 that names the step the transaction is on.

Examples

GET /openapi/Offers?propertyId={propertyId}: response right after submission

{
  "items": [
    {
      "id": "9b8a7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
      "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
      "transactionId": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
      "type": "CashOffer",
      "kind": "Estimated",
      "status": "Estimated",
      "disposition": "Available",
      "currentRevisionId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "isAvailable": true,
      "isAccepted": false,
      "isExpired": false,
      "hasUnacceptedRevision": false,
      "expiresAt": null,
      "eTag": "\"0x8DCA…\"",
      "detailsShared": false,
      "amount": null,
      "estimatedRange": { "low": 267750, "high": 362250 },
      "cashOffer": null,
      "cashOfferPlus": null,
      "sellNowMoveLater": null,
      "listOnMarket": null
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 20
}

GET /openapi/Offers/{id}: an actual offer before details are shared

{
  "id": "1c2d3e4f-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "transactionId": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
  "type": "CashOffer",
  "kind": "Actual",
  "status": "Sent",
  "disposition": "Available",
  "currentRevisionId": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a",
  "isAvailable": true,
  "isAccepted": false,
  "isExpired": false,
  "hasUnacceptedRevision": false,
  "expiresAt": "2026-10-08T12:00:00Z",
  "eTag": "\"0x8DCB…\"",
  "detailsShared": false,
  "amount": 318000,
  "estimatedRange": null,
  "cashOffer": null,
  "cashOfferPlus": null,
  "sellNowMoveLater": null,
  "listOnMarket": null
}

POST /openapi/Offers/{id}/accept: request (estimated offer; body optional)

{
  "attributes": {
    "bedroomCount": 4,
    "bathroomCount": 3,
    "squareFootage": 2450,
    "yearBuilt": 2016
  }
}

POST /openapi/Offers/{id}/accept: 200 OK response (the transaction)

{
  "id": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
  "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "isActive": true,
  "stage": "OfferRequested",
  "detailsDisclosure": "Unshared",
  "eTag": "\"0x8DCC…\""
}

GET /openapi/Offers/{id}/history: response

{
  "id": "1c2d3e4f-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "statusHistory": [
    { "from": "Finalizing", "to": "Sent", "at": "2026-09-24T14:00:00Z" },
    { "from": "Sent", "to": "Accepted", "at": "2026-09-25T09:30:00Z" }
  ]
}

Transactions and AI comping

Read-only. A transaction is one selling journey for a property; follow its stage here or, better, through the `transaction.stage_changed` webhook.

Examples

GET /openapi/Transactions/{transactionId}: response

{
  "id": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
  "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "isActive": true,
  "stage": "CompingComplete",
  "detailsDisclosure": "Unshared",
  "eTag": "\"0x8DCB…\""
}

GET /openapi/Transactions/{transactionId}/comping: response

{
  "transactionId": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
  "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "status": "completed",
  "revealUrl": "https://<app-host>/properties/5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a/offer-reveal"
}

Team

The people in your workspace and the teams they belong to. Use a member id as a property’s `agentId`.

Good to know

role is Owner (the workspace owner), AccountAdmin (manages the whole workspace) or Member. Team admins are members who administer one or more teams; teamIds lists every team a member is on.
Teams nest: parentTeamId points at the team above. A team admin reaches every team below theirs. What you can read and do follows your own role, exactly as in the app.
Inviting returns an invite, not a member: id is the invite id and token is the link code. The person becomes a member once they accept at /invite?token=…. Put them on teams with teamIds, and make them a team admin with adminTeamIds.
DELETE takes either id: a member id removes the member, an invite id revokes the invite. The workspace owner cannot be removed, and a member who still has homeowners assigned must be reassigned in the app first.
List filters: search, page, pageSize.

Examples

GET /openapi/Team/members: response

{
  "items": [
    {
      "id": "3f6c1a2e-9b4d-4c1f-8a2b-1d2e3f4a5b6c",
      "fName": "Alex",
      "lName": "Smith",
      "email": "alex.smith@example.com",
      "role": "Member",
      "teamIds": ["d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a"],
      "archivedAt": null
    }
  ],
  "page": 1,
  "pageSize": 20,
  "totalCount": 1
}

POST /openapi/Team/members: request

{
  "email": "sam.lee@example.com",
  "teamIds": ["d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a"],
  "adminTeamIds": []
}

201 Created: response (an invite, not yet a member)

{
  "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
  "token": "Kt7…",
  "expiresAt": "2026-10-08T12:00:00Z"
}

GET /openapi/Team/teams: response

{
  "items": [
    {
      "id": "d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a",
      "name": "Texas",
      "description": null,
      "parentTeamId": null,
      "memberCount": 12
    }
  ],
  "page": 1,
  "pageSize": 20,
  "totalCount": 1
}

Webhooks

Zoodealio calls your HTTPS endpoint at every step of the journey, so you never have to poll.

Good to know

transaction.stage_changed fires at every step of the journey with previousStage, stage and phase. It is the one event to subscribe to if you want to mirror progress.
The milestones have their own events: offer.created (estimate or offers published), comping.completed / comping.failed, offer.details_shared (full terms ready), offer.accepted, offer.declined, offer.updated, offer.ready, offer.countered, and property.files_imported (a photo/document import finished). An empty event list subscribes to all of them.
Payloads carry ids and status, not terms: offer amounts appear in a payload only once details are shared. Read the offer from the API when you need the numbers.
Use a public HTTPS endpoint. Private and local network destinations, URL credentials and redirects are rejected. Set isActive: false to pause while retaining the delivery log.
Delivery is at least once: de-duplicate on envelope id (also X-Zoodealio-Delivery), which stays stable across retries. Access is checked again before every send.
Verify X-Zoodealio-Signature: t=<unix>,v1=<hex> as HMAC-SHA256 using the signing secret and the exact bytes of <t>.<raw body>. Compare in constant time and reject stale timestamps. X-Zoodealio-Event gives the event type.
Return a 2xx quickly. Non-2xx, timeouts and connection failures retry with exponential backoff (default six attempts). After exhaustion the delivery is Failed in the log.

Delivery envelope (POST body)

{
  "id": "6f1e2d3c-4b5a-4968-8776-5a4b3c2d1e0f",
  "type": "comping.completed",
  "apiVersion": "2026-09-22",
  "occurredAt": "2026-09-22T18:04:11Z",
  "tenantId": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
  "data": { "…": "event-specific fields" }
}

Examples

POST /openapi/Webhooks: request

{
  "endpointUrl": "https://partner.example/zoodealio",
  "eventTypes": [
    "transaction.stage_changed",
    "property.files_imported",
    "comping.completed",
    "comping.failed",
    "offer.details_shared"
  ]
}

property.files_imported: data

{
  "importId": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "photoIds": ["c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f", "…"],
  "documentIds": ["e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b"],
  "failed": [
    {
      "source": "https://cdn.example.com/listings/102-shore/kitchen.jpg",
      "reason": "The URL answered 404."
    }
  ]
}

transaction.stage_changed: data

{
  "transactionId": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
  "propertyId": "5d4c3b2a-1f0e-9d8c-7b6a-5f4e3d2c1b0a",
  "previousStage": "CompingInProgress",
  "stage": "CompingComplete",
  "phase": "OffersReady",
  "outcome": null,
  "eTag": "\"0x8DCB…\""
}

Glossary

The terms these docs use, in one place.

API key: A personal zoo_… key. It acts as you, with your role and access, and is shown once. More
Property: The core record: an address, the home’s details, its homeowner, photos and documents. Everything else hangs off a property. More
Homeowner: The person selling. Attach one inline when you submit a property; the property returns their homeownerId. More
Estimated offer: The instant estimate a property gets on submission. The API returns only its range, estimatedRange: { low, high }. More
Actual offer: A real offer produced by AI comping. Its headline amount is visible; its terms appear once details are shared. More
AI comping: Zoodealio’s AI valuation that turns the estimate into real offers. Accepting the estimate starts it. More
Details shared: Terms stay null until you request details and Zoodealio shares them (detailsShared: true). More
Transaction: One selling journey for a property. Its stage says which step it is on; every change is a transaction.stage_changed webhook. More
Member: A person in your workspace: Owner, AccountAdmin or Member. A member id is a property’s agentId. More
Team: A group of members. Teams nest; a team admin reaches every team below theirs. More
Invite: How someone joins. Inviting returns an invite id; they become a member when they accept it. More
Import: A background download of a property’s photo and document URLs. It returns an importId; property.files_imported fires when it finishes. More
ETag / If-Match: Send the ETag from a GET as If-Match to reject a write if someone changed the record. More
Webhook: A signed POST Zoodealio sends to your HTTPS endpoint when something happens, retried until you answer 2xx. More

Build on Zoodealio

Quickstart: the whole journey

For AI agents

Docs for LLMs

Docs MCP server

Account MCP server

Agent skills

Getting started

One base URL

Authentication

The same actions as the app

What you see, and when

Teams and workspace moves

Ids in the path, not the body

Rate limiting

Errors

Status codes

Properties

Offers

Transactions and AI comping

Team

Webhooks

Glossary

Questions

Quickstart: the whole journey

For AI agents

Docs for LLMs

Docs MCP server

Account MCP server

Agent skills

Getting started

One base URL

Authentication

The same actions as the app

What you see, and when

Teams and workspace moves

Ids in the path, not the body

Rate limiting

Errors

Status codes

Properties

GET/openapi/PropertiesList properties

GET/openapi/Properties/{id}Get one property

POST/openapi/PropertiesSubmit a property; photo and document URLs import in the background

PUT/openapi/Properties/{id}Correct the address or details

GET/openapi/Properties/{id}/photosList photos

POST/openapi/Properties/{id}/photosImport photos from URLs (background)

DELETE/openapi/Properties/{id}/photos/{photoId}Delete a photo

GET/openapi/Properties/{id}/documentsList documents

POST/openapi/Properties/{id}/documentsImport documents from URLs (background)

DELETE/openapi/Properties/{id}/documents/{documentId}Delete a document you uploaded

GET/openapi/Properties/{id}/imports/{importId}Where a file import stands

Offers

GET/openapi/Offers?propertyId={propertyId}List a property’s offers: propertyId is required

GET/openapi/Offers/{id}Get one offer

GET/openapi/Offers/{id}/historyStatus changes over time

POST/openapi/Offers/{id}/acceptAccept the estimate (starts AI comping) or accept a final offer

POST/openapi/Offers/{id}/request-detailsAsk for the offer’s full terms

Transactions and AI comping

GET/openapi/Transactions/active?propertyId={propertyId}The property’s active transaction; 204 when there is none

GET/openapi/Transactions/{transactionId}Stage, phase, disclosure state and ETag

GET/openapi/Transactions/{transactionId}/compingAI comping status and the reveal link

Team

GET/openapi/Team/membersList members

GET/openapi/Team/members/{id}Get one member

POST/openapi/Team/membersInvite a member

DELETE/openapi/Team/members/{id}Remove a member, or revoke a pending invite

GET/openapi/Team/teamsList teams

Webhooks

GET/openapi/WebhooksList your subscriptions

POST/openapi/WebhooksCreate; signing secret shown once

PUT/openapi/Webhooks/{id}Replace your subscription settings

DELETE/openapi/Webhooks/{id}Delete with its delivery log

POST/openapi/Webhooks/{id}/rotateRotate the signing secret

GET/openapi/Webhooks/event-typesCurrent event catalogue

GET/openapi/Webhooks/deliveriesYour delivery attempts

Glossary

Questions

Is there a sandbox or test key?

Why is an offer amount null?

How do I start AI comping?

Do I have to send details and photos when accepting the estimate?

How do I send photos and documents?

Can I create or change an offer?

Where are clients?

Can I call the API from a browser?

Should I poll or use webhooks?

Does the API have versions?