Matchai Docs

Get this connectionComing soon

Describes the connection your credentials belong to: the app, the scopes granted, whether final actions ask first (ask_me) or run straight away (allowed),…

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

Coming soon. Describes the connection your credentials belong to: the app, the scopes granted, whether final actions ask first (ask_me) or run straight away (allowed), and whether it is a free test connection.

Scopes: none beyond a valid key or token

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.

Response Body

The connection.

application/json
  1. response

The connection your credentials belong to: one Matchai account connected to one app.

id*string

Connection id.

Length1 <= length <= 64
app*
auth_type*string

How this request authenticated.

Value in"api_key""oauth"
scopes*array<string>

The scopes granted to these credentials.

approval_mode*string

ask_me: final actions wait for the account holder’s approval. allowed: they run straight away. The account holder chooses this in Matchai.

Value in"ask_me""allowed"
test_mode*boolean

True when the app is connected only to its own developer’s account. Test connections are not billed.

energy_limit_reached?boolean

True when this connection has used the Energy limit the account holder set for it.

created_at*string

When the account holder connected the app.

Formatdate-time
last_used_at?|

Last request made with this connection.

Formatdate-time
Example Request
curl -X GET 'https://api.matchai.co/v1/me/connection'
Example Response
{  "id": "string",  "app": {    "id": "string",    "name": "string",    "logo_url": "http://example.com",    "website": "http://example.com",    "verified": true  },  "auth_type": "api_key",  "scopes": [    "string"  ],  "approval_mode": "ask_me",  "test_mode": true,  "energy_limit_reached": true,  "created_at": "2019-08-24T14:15:22Z",  "last_used_at": "2019-08-24T14:15:22Z"}