Me

Update the current caller's profile

PATCH
/v1/me

Partial update — send only the fields that change; null clears one. Returns the account in the same shape as GET /v1/me.

email is NOT updatable here: changing it runs a verification flow. Sending it is a 400, not a silent no-op.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/me" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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",
    "state": "string",
    "tagline": "string",
    "theme": "string"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}
{
  "error": "string"
}

Get the caller's current plan GET

The active organization's resolved plan (with its limit map), the subscription status backing it, and the plan grants attached to the organization and to the user. `plan` is null when the workspace has no active, trialing, or past-due subscription. No billing details (invoices, payment methods) are exposed.

Count offices matching filters POST

Return the exact number of offices matching the given filters. Accepts the same request body as `listOffices` (pagination and sort are ignored). Use this when you only need a total; to get the matching offices themselves, send the same request body to `listOffices`.