Get the current caller's account

getapi.modelmatch.com/v1/me

Identity, active organization + membership role, and how the caller authenticated.

Extended profile fields (nmlsId, jobRole, the contact-card block) are resolved for every caller type — session-cookie, API-key, and OAuth-bearer alike. auth.profileResolved is true on any successful read; it is retained for compatibility and no longer varies by the credential the caller presented.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Responses

200objectThe caller's account

Show attributes

authobjectrequired

Show child attributes

clientIdstring | null

OAuth client that minted the token, when applicable

methodenumrequired

Which credential the API resolved this caller from

Options:api-keybearersessioninternal

profileResolvedbooleanrequired

Always true on a successful read; retained for compatibility now that every caller type resolves the full profile

rolestringrequired

Global user role

scopesstring[] | null

OAuth scopes on the bearer token; null for API-key / session callers

organizationobject | nullrequired

Show child attributes

idstringrequired

rolestring | null

The caller's MEMBERSHIP role in this org (owner/admin/member)

userobjectrequired

Show child attributes

addressLine1string | null

agentPhotoUrlstring | null

citystring | null

contactCardTypestring | null

contactPhonestring | null

createdAtstring | null

emailstring | null

emailVerifiedboolean | null

headlinestring | null

idstringrequired

Auth user id

imagestring | null

jobRolestring | null

namestring | null

nmlsIdstring | null

postalCodestring | null

qrBaseUrlstring | null

reLicenseNumberstring | null

reLicenseStatestring | null

sendNewLoginEmailboolean | null

signatureImagestring | null

statestring | null

taglinestring | null

themestring | null

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

502objectAccount service unavailable

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X GET "https://api.modelmatch.com/v1/me" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient, Me } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Me.get();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/me",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "auth": {
    "clientId": "<string>",
    "method": "api-key",
    "profileResolved": true,
    "role": "<string>",
    "scopes": [
      "<string>"
    ]
  },
  "organization": {
    "id": "<string>",
    "role": "<string>"
  },
  "user": {
    "addressLine1": "<string>",
    "agentPhotoUrl": "<string>",
    "city": "<string>",
    "contactCardType": "<string>",
    "contactPhone": "<string>",
    "createdAt": "<string>",
    "email": "<string>",
    "emailVerified": true,
    "headline": "<string>",
    "id": "<string>",
    "image": "<string>",
    "jobRole": "<string>",
    "name": "<string>",
    "nmlsId": "<string>",
    "postalCode": "<string>",
    "qrBaseUrl": "<string>",
    "reLicenseNumber": "<string>",
    "reLicenseState": "<string>",
    "sendNewLoginEmail": true,
    "signatureImage": "<string>"
  }
}