AppNameAppName/ApiDocsBadgeApiDocsBackToSite

Get User Profile

POST/external/v1/users/profile/

Return a user profile and a summary of all company tenants linked to them. Results are scoped to the calling application — a key cannot read users registered by another application.

ApiDocsParametersTitle

ApiDocsParamFieldApiDocsParamTypeApiDocsParamRequiredApiDocsParamDescription
emailstringApiDocsRequiredEmail of the user to look up. Must have been registered with the same key.
ApiDocsRequestLabel
curl -X POST https://<api-host>/external/v1/users/profile/ \
  -H "X-API-Key: <encrypted_token>" \
  -H "Content-Type: application/json" \
  -d '{ "email": "jane.doe@example.com" }'
ApiDocsResponseLabel
{
  "status": "success",
  "status_code": 200,
  "data": {
    "user_id": "42",
    "email": "jane.doe@example.com",
    "tenant_count": 1,
    "tenants": [ "... tenant summaries ..." ]
  }
}