Matchai Docs

Look up a professionalComing soon

Returns the public profile of a professional by their handle: name, headline, agency, professions, socials and the addresses of their Matchai Site and…

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

Coming soon. Returns the public profile of a professional by their handle: name, headline, agency, professions, socials and the addresses of their Matchai Site and Matchai Page. Only what they already publish.

Scopes: none — public. An API key or token is optional and raises your rate limit.

Pricing: Free. No connection needed.

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.

Path Parameters

username*string

The professional’s public handle.

Match^[a-z0-9][a-z0-9_-]{1,38}$

Response Body

The public profile.

application/json
  1. response

What anyone can see about a professional. Only public information.

username*string

Public handle.

display_name*string

Name as Matchai shows it.

first_name?|

First name.

last_name?|

Last name.

headline?|

The headline on their Matchai Page.

job_title?|

Job title.

organization_name?|

Agency or brokerage.

biography?|

Short biography.

avatar_url?|

Profile picture.

Formaturi
industry_roles?array<string>

Professions, for example realty_residential.

social_links?

Public profile links. Every key is optional.

site_url?|

Their Matchai Site, when published.

Formaturi
page_url?|

Their Matchai Page, when published.

Formaturi
booking_enabled*boolean

Whether visitors can book time with them.

timezone?|

IANA time zone their availability is expressed in.

Example Request
curl -X GET 'https://api.matchai.co/v1/professionals/string'
Example Response
{  "username": "string",  "display_name": "string",  "first_name": "string",  "last_name": "string",  "headline": "string",  "job_title": "string",  "organization_name": "string",  "biography": "string",  "avatar_url": "http://example.com",  "industry_roles": [    "string"  ],  "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_url": "http://example.com",  "page_url": "http://example.com",  "booking_enabled": true,  "timezone": "string"}