> ## 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.

# Partner applications

> How software companies integrate with myAbode Deals across many Canadian brokerages using partner application keys and brokerage grants.

A **partner application** is for a company whose software serves several brokerages on myAbode Deals, such as a deal-operations tool, a CRM or an accounting product. Instead of asking each brokerage for its own key, the partner gets one application, and each brokerage grants that application access.

## How it works

1. myAbode registers your application and the scopes it needs.
2. myAbode issues you an application key. It starts with `myapp_`.
3. Each brokerage that wants to use your product grants your application access.
4. Your key reads every brokerage that has granted access, with the application's scopes. Use the `brokerage` filter on the deals, tasks, users, offices and events lists to narrow to one. On the users list the filter only chooses which users come back: each user still lists their memberships in every brokerage your key can read.

```bash theme={null}
curl "https://api.myabode.ca/v1/brokerages" \
  -H "Authorization: Bearer myapp_your_key_here"
```

## What changes take effect immediately

Access is checked on every request:

* A brokerage that removes its grant drops out of your results on the next call.
* If myAbode disables an application, all of its keys stop working at once. Re-enabling it restores the existing grants and keys.
* A brokerage that leaves myAbode stops appearing.

A grant covers all of the application's scopes. It can't be partial.

## Becoming a partner

Contact myAbode to register an application. Tell us what your product does, which brokerages you work with and which [scopes](https://docs.myabode.ca/api/authentication.md#scopes) you need.


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