> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myabode.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# myAbode Deals API

> The myAbode Deals REST API gives Canadian brokerages read access to their real estate deals, deal tasks, agents and offices, with an event feed to keep CRMs, accounting and reporting tools in sync.

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`

```bash theme={null}
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`](https://docs.myabode.ca/api/reference/list-deals), [`GET /v1/deals/{id}`](https://docs.myabode.ca/api/reference/retrieve-a-deal) | Property address, status, deal type, prices, key dates, agents and parties |
| **Tasks** | [`GET /v1/tasks`](https://docs.myabode.ca/api/reference/list-tasks), [`GET /v1/tasks/{id}`](https://docs.myabode.ca/api/reference/retrieve-a-task) | The work open on each deal, who holds it and its status |
| **Users** | [`GET /v1/users`](https://docs.myabode.ca/api/reference/list-users), [`GET /v1/users/{id}`](https://docs.myabode.ca/api/reference/retrieve-a-user) | Agents and staff, with their roles and offices |
| **Offices** | [`GET /v1/offices`](https://docs.myabode.ca/api/reference/list-offices), [`GET /v1/offices/{id}`](https://docs.myabode.ca/api/reference/retrieve-an-office) | Your brokerage's offices (branches) |
| **Brokerages** | [`GET /v1/brokerages`](https://docs.myabode.ca/api/reference/list-brokerages) | The brokerages your key can read |
| **Events** | [`GET /v1/events`](https://docs.myabode.ca/api/reference/list-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](https://docs.myabode.ca/api/authentication.md).
* **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](https://docs.myabode.ca/api/pagination.md).
* **One error format.** Every error is an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem-details body with a stable `code`. See [Errors](https://docs.myabode.ca/api/errors.md).
* **Rate limits.** 120 requests a minute per key. See [Rate limits](https://docs.myabode.ca/api/rate-limits.md).
* **OpenAPI.** The full specification is at [`api.myabode.ca/v1/openapi.json`](https://api.myabode.ca/v1/openapi.json), ready for code generators and API clients.

## Next steps

1. [Make your first call](https://docs.myabode.ca/api/quickstart.md)
2. [Keep a system in sync with events](https://docs.myabode.ca/api/events.md)
3. [Browse the endpoint reference](https://docs.myabode.ca/api/reference/list-deals.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.