Matchai Docs

List conversationsComing soon

Returns your conversations, most recent activity first, with who wrote last and how many messages are unread.

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

Coming soon. Returns your conversations, most recent activity first, with who wrote last and how many messages are unread.

Scopes: messages: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: messages: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
unread?boolean

Only conversations with unread messages.

archived?boolean

Archived conversations instead of current ones.

contact_id?string

Only conversations with this contact.

listing_id?string

Only conversations about this listing.

Response Body

One page of conversations.

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/conversations'
Example Response
{  "data": [    {      "id": "string",      "type": "direct",      "channel": "matchai",      "name": "string",      "participants": [        {          "user_id": "string",          "contact_id": "string",          "display_name": "string",          "avatar_url": "http://example.com"        }      ],      "context": {        "listing_id": "string",        "contact_id": "string",        "project_id": "string",        "team_id": "string"      },      "last_message": {        "id": "string",        "preview": "string",        "sender_user_id": "string",        "sent_at": "2019-08-24T14:15:22Z"      },      "unread_count": 0,      "archived": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}