myAbode Deals API

The myAbode Deals API lets a brokerage read its own deals, the tasks on them, its people and its offices from its own software. Use it to feed a CRM, build reporting, or keep an accounting or back-office system in sync. It is a read-only REST API that returns JSON. Base URL: https://api.myabode.ca

curl https://api.myabode.ca/v1/deals \
  -H "Authorization: Bearer mya_your_key_here"

What you can read

Resource	Endpoints	What it holds
Deals	`GET /v1/deals`, `GET /v1/deals/{id}`	Property address, status, deal type, prices, key dates, agents and parties
Tasks	`GET /v1/tasks`, `GET /v1/tasks/{id}`	The work open on each deal, who holds it and its status
Users	`GET /v1/users`, `GET /v1/users/{id}`	Agents and staff, with their roles and offices
Offices	`GET /v1/offices`, `GET /v1/offices/{id}`	Your brokerage’s offices (branches)
Brokerages	`GET /v1/brokerages`	The brokerages your key can read
Events	`GET /v1/events`	Every deal and task change, in order, for keeping other systems in sync

How it works

Keys, not passwords. Every request carries an API key. A brokerage admin creates service keys in myAbode Deals. See Authentication and API keys.
Scoped keys. A service key reads its brokerage, a member key reads what its member can see, and a partner application key reads each brokerage that has granted it access.
Cursor pagination. Lists return up to 100 items a page, each list in its own fixed order. See Pagination.
One error format. Every error is an RFC 9457 problem-details body with a stable code. See Errors.
Rate limits. 120 requests a minute per key. See Rate limits.
OpenAPI. The full specification is at api.myabode.ca/v1/openapi.json, ready for code generators and API clients.

API guides

Endpoint reference

What you can read

How it works

Next steps

​What you can read

​How it works

​Next steps

What you can read

How it works

Next steps