Overview

Welcome to the Treedis API.

The Treedis API is a REST API for managing projects, tours, users, virtual staging, tags, and more — the same capabilities that power the Treedis platform, available programmatically.

Base URLs

Production: https://api.treedis.com
Staging: https://stage-api.treedis.com

All endpoints are served under the /v1/api path.

Authentication

The API uses OAuth2 as its primary authentication method, with a legacy API key also accepted.

OAuth2 (recommended) — exchange your client credentials at POST /v1/api/oauth2/token for a short‑lived access token, then send it as Authorization: Bearer {access_token}.
API key (legacy) — send your key in the X-API-Key header.

Authentication The full OAuth2 flow, scopes, token rotation, and the legacy API key.

Response format

Successful responses use a consistent envelope:

{
  "status": 200,
  "message": "Success",
  "timestamp": 1716146262053,
  "data": { }
}

What's in these docs

Quickstart

Authenticate and make your first call.

Quickstart From credentials to your first request in minutes.

Authentication

Set up OAuth2, scopes, and token refresh.

Authentication OAuth2 flow, scopes, and refresh-token rotation.

API Reference

Browse every endpoint, with request and response schemas.

API Reference Complete, interactive OpenAPI reference.

Endpoint groups

The API Reference is organized into:

OAuth2 & Auth — tokens, client credentials, and user login
Projects — projects and their leads, objects, listings, polygons, assets, promotions, and timelines
Tours — tours and tour management, incl. PME (Private Model Embed) access tokens
Virtual Staging — polygons, images, objects, videos, and VS settings on a tour
Tags — tag categories, loading, and import
Brand Profiles, Users & Permissions — account management
Notes — create and update notes (threads) and add messages
Connected Workers — locations, assets, lists, columns, and items

Quickstart