Matchai Docs

List invitationsComing soon

Returns invitations to teams, projects and conversations, sent or received.

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

Coming soon. Returns invitations to teams, projects and conversations, sent or received.

Scopes: teams:read and projects: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: teams:read, projects: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
direction?string

Sent or received. Defaults to received.

Value in"sent""received"
status?string

Only this status.

Value in"pending""accepted""declined""expired""revoked"

Response Body

One page of invitations.

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/invitations'
Example Response
{  "data": [    {      "id": "string",      "target": {        "type": "team",        "id": "string",        "name": "string"      },      "role": "owner",      "direction": "sent",      "status": "pending",      "invited": {        "display_name": "string",        "email": "user@example.com",        "phone": "string"      },      "invited_by": {        "user_id": "string",        "display_name": "string"      },      "delivery": {        "channel": "email",        "state": "pending"      },      "accept_url": "http://example.com",      "expires_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "responded_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}