Matchai Docs

List documentsComing soon

Returns the Matchai Cloud documents you can open, newest first.

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

Coming soon. Returns the Matchai Cloud documents you can open, newest first.

Scopes: documents: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: documents: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
query?string

Words from the file name.

Lengthlength <= 80
place_type?string

Only documents in this kind of place (with place_id).

Value in"listing""conversation""contact""team""project"
place_id?string

Only documents in this place.

tag?string

Only documents with this tag, written facet:value, for example kind:seller_declaration.

Match^(kind|status|source|period):[a-z0-9_]+$
unfiled?boolean

Only documents read but not filed anywhere yet.

in_trash?boolean

List the trash instead.

Response Body

One page of documents.

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/documents'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "mime_type": "string",      "size_bytes": 0,      "visibility": "private",      "tags": [        {          "facet": "kind",          "value": "string"        }      ],      "places": [        {          "type": "listing",          "id": "string",          "name": "string"        }      ],      "summary": "string",      "reading_status": "not_read",      "download_url": "http://example.com",      "uploaded_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "archived_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}