Getting started

What this API is

The agent site API lets external systems create clients in a specific UMe IDX website — Zapier, custom ETL, MLS portals, or your own CRM sync.

Version 1 exposes a single write endpoint. Creating a client adds them to the agent’s CRM and provisions a consumer login on the branded site. For new users, the initial password is their phone number (digits only). See Create a client.

Site-scoped keys

Every API token is bound to one agent site (and its organization). The host you call does not choose the site — the key does. A token created under Website A cannot insert clients into Website B.

Create and manage tokens in the agent dashboard under Website → Integrations → API Access.

Base URL

Call the API on the platform app host or any branded agent host — both serve the same route:

https://app.umeidx.com/api/v1/clients

Or on a branded site:

https://your-agent-domain.com/api/v1/clients

Use HTTPS and Content-Type: application/json. Cookie sessions are not required.

Next steps

1. Authentication — create a token and send Authorization: Bearer …
2. Create a client — request body, tags, notes, and responses