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

# Quickstart: list your deals

> Make your first myAbode Deals API call in five minutes. Create an API key, list your brokerage's real estate deals with curl, and read the response.

This guide takes you from no key to a list of your brokerage's deals.

## 1. Create a key

A brokerage admin creates keys in myAbode Deals:

1. Open your account menu (your name, bottom left) and choose **Get API Keys**.
2. Under your brokerage, choose **Create service key**, name it after what will use it (for example "Reporting dashboard") and pick its scopes. For this guide, **Read deals** is enough.
3. Copy the key. It starts with `mya_` and is shown **once**. Store it in a secrets manager, not in source code.

See [Authentication and API keys](https://docs.myabode.ca/api/authentication.md) for the kinds of key and what each scope allows.

## 2. List deals

```bash theme={null}
export MYABODE_API_KEY=mya_your_key_here

curl "https://api.myabode.ca/v1/deals?limit=2" \
  -H "Authorization: Bearer $MYABODE_API_KEY"
```

## 3. Read the response

Lists come back in one envelope:

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "object": "deal",
      "id": "q9lmv8ce5rlucyc0lljw0a4l",
      "status": "IN_PROGRESS",
      "deal_type": "urn:myabode:deal-type:res-listing-sale",
      "address": {
        "line1": "286 Harbour Street",
        "line2": null,
        "city": "Mississauga",
        "province": "ON",
        "postal_code": "L9N 4C0"
      },
      "mls_number": "W1234567",
      "sale_price": "1000000.00"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJrIjpbIjIwMjYtMTItMDEi..."
}
```

The example is shortened. See [List deals](https://docs.myabode.ca/api/reference/list-deals.md) for every field. Amounts are strings with two decimals, so no precision is lost.

## 4. Filter and page

```bash theme={null}
# Deals in processing, changed since November 1
curl "https://api.myabode.ca/v1/deals?status=IN_PROGRESS&updated_since=2026-11-01T00:00:00Z" \
  -H "Authorization: Bearer $MYABODE_API_KEY"

# The next page
curl "https://api.myabode.ca/v1/deals?cursor=eyJrIjpbIjIwMjYtMTItMDEi..." \
  -H "Authorization: Bearer $MYABODE_API_KEY"
```

## Next

* [Keep your system in sync with events](https://docs.myabode.ca/api/events.md)
* [Handle errors](https://docs.myabode.ca/api/errors.md)


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