Matchai Docs

List your listingsComing soon

Returns the listings you can manage — yours and your teams’ — most recently changed first.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/listings

Coming soon. Returns the listings you can manage — yours and your teams’ — most recently changed first.

Scopes: listings:read

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: listings:read

Query Parameters

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512
status?string

Only listings with this status.

Value in"draft""published""archived"
availability?string

Only listings in this market state.

Value in"available""sold""rented""withdrawn"
query?string

Words from the title or the address.

Length3 <= length <= 200
team_id?string

Only listings owned by this team.

updated_since?string

Only listings changed after this time. Use it to sync.

Formatdate-time
locale?string

Return text in this language when a translation exists, the original text otherwise.

Value in"en-US""fr-CA""es"

Response Body

One page of listings.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/listings'
Example Response
{  "data": [    {      "id": "string",      "slug": "string",      "url": "http://example.com",      "status": "draft",      "availability": "available",      "transaction_types": [        "for_sale"      ],      "title": "string",      "description": "string",      "highlights": [        "string"      ],      "price": {        "amount": 1,        "currency": "string"      },      "address": {        "formatted": "string",        "street": "string",        "unit": "string",        "city": "string",        "region": "string",        "postal_code": "string",        "country": "string"      },      "coordinates": {        "latitude": -90,        "longitude": -180      },      "neighbourhood": "string",      "neighbourhood_summary": "string",      "neighbourhood_tags": [        "string"      ],      "property": {        "property_type": "house",        "building_type": "detached",        "categories": [          "residential"        ],        "bedrooms": 0,        "bathrooms": 0,        "living_area_sqft": 0,        "lot_size_sqft": 0,        "year_built": 1600,        "parking_spaces": 0,        "stories": 0      },      "virtual_tour_url": "http://example.com",      "cover_image_url": "http://example.com",      "media_count": 0,      "content_locale": "en-US",      "owner": {        "type": "user",        "id": "string",        "name": "string"      },      "sites": [        {          "site_id": "string",          "featured": true        }      ],      "listed_on": "2019-08-24",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}