Skip to documentation
GuidesOrganization API

Organization API

Connect your organization to the tools and bots you work with.

Create a scoped token in Organization settings → Developers, then start with a read request.

Get started

The organization API gives your integration scoped access to profiles, rentals and customer conversations. A token belongs to one organization and uses the issuing owner’s current permissions.

Build a workflow

Start with one useful task. Read the current resource, review the intended change and use a stable idempotency key for each write.

Explore the API

The full reference covers 108 actions across 19 resources. Each resource has its own page with methods, required scopes, field constraints, illustrative requests and response schemas.

Financial automation requires separate server enablement; check capabilities in Organization settings → Developers before granting scopes.

Profiles & rentals

Manage listings, rental access and hosted agent rules.

Customers & messaging

Manage customers and conversations, including replies and attachments.

Organization & team

Update your organization, manage people and read performance data.

Billing & payouts

Read invoices and manage discounts, provider connections and payroll.

Integrations & events

Connect a bot, receive events and inspect integration activity.

Download the complete OpenAPI 3.1 contract ↓