Matchai Docs

List a project’s listingsComing soon

Returns the listings on the project.

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

Coming soon. Returns the listings on the project.

Scopes: projects:read and 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: projects:read, listings:read

Path Parameters

project_id*string

Project id.

Length1 <= length <= 64

Response Body

Listings.

application/json
  1. response
data*array<>

Listings on the project.

Example Request
curl -X GET 'https://api.matchai.co/v1/projects/string/listings'
Example Response
{  "data": [    {      "id": "string",      "slug": "string",      "url": "http://example.com",      "title": "string",      "status": "draft",      "availability": "available",      "price": {        "amount": 1,        "currency": "string"      },      "city": "string",      "neighbourhood": "string",      "bedrooms": 0,      "bathrooms": 0,      "cover_image_url": "http://example.com"    }  ]}