Matchai Docs

Get the connected accountComing soon

Returns the Matchai account this key or token acts for: profile, language, time zone, site and page, and the state of its Matchai Energy (never a number).

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

Coming soon. Returns the Matchai account this key or token acts for: profile, language, time zone, site and page, and the state of its Matchai Energy (never a number). Every key and token reaches exactly one account.

Scopes: profile: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: profile:read

Response Body

The account.

application/json
  1. response

The Matchai account this connection acts for.

user_id*string

Account id.

Length1 <= length <= 64
professional_id?|

Present when the account is a professional account.

Length1 <= length <= 64
username*|

Public handle. It is also the address of the Matchai Page.

first_name*|

First name.

last_name*|

Last name.

display_name*string

Name as Matchai shows it.

email?|

Sign-in email. Private: never shown on public pages.

Formatemail
avatar_url?|

Profile picture.

Formaturi
biography?|

Short biography shown on public pages.

job_title?|

Job title, for example "Residential real estate broker".

industry_roles?array<>

The professions the account works in. New values may be added.

work_email?|

Public work email.

Formatemail
work_phone?|

Public work phone, E.164.

office_address?|null
timezone?|

IANA time zone, for example America/Toronto.

language*Locale

A language Matchai publishes in: English (en-US), Québec French (fr-CA) or Spanish (es).

Value in"en-US""fr-CA""es"
social_links?

Public profile links. Every key is optional.

site_id?|

The account’s Matchai Site, if it has one.

Length1 <= length <= 64
page_url?|

The public address of the account’s Matchai Page, when it is published.

Formaturi
energy*

Matchai Energy, as a state. Actions that spend Energy return 402 when there is not enough.

created_at*string

When the account was created.

Formatdate-time
Example Request
curl -X GET 'https://api.matchai.co/v1/me'
Example Response
{  "user_id": "string",  "professional_id": "string",  "username": "string",  "first_name": "string",  "last_name": "string",  "display_name": "string",  "email": "user@example.com",  "avatar_url": "http://example.com",  "biography": "string",  "job_title": "string",  "industry_roles": [    "string"  ],  "work_email": "user@example.com",  "work_phone": "string",  "office_address": {    "formatted": "string",    "street": "string",    "unit": "string",    "city": "string",    "region": "string",    "postal_code": "string",    "country": "string"  },  "timezone": "string",  "language": "en-US",  "social_links": {    "website": "http://example.com",    "linkedin": "http://example.com",    "instagram": "http://example.com",    "facebook": "http://example.com",    "x": "http://example.com",    "youtube": "http://example.com",    "tiktok": "http://example.com"  },  "site_id": "string",  "page_url": "http://example.com",  "energy": {    "balance_state": "full"  },  "created_at": "2019-08-24T14:15:22Z"}