Endpoints

Account

GET/v0/user-profile

Retrieve your account

The user and company your API key belongs to. Call it first: companyId is the {companyId} in every /v0/companies/{companyId}/... route, and permissions lists what your account may do.

ReturnsSuccess

idstring
Your user ID.
emailstring
The email address you sign in with.
permissionsstring[]
What your account may do, such as `ViewPatients` or `ManageWebhooks`.

Conditional attributes

firstNamestring
Your first name. Null when not set.
lastNamestring
Your last name. Null when not set.
lastLoginstring
Reserved for the time of your last sign-in. Currently always null.
createdAtstring
When your account was created, as an RFC 3339 timestamp. Null when not recorded.
updatedAtstring
When your account was last changed, as an RFC 3339 timestamp. Null when not recorded.
companyIdinteger
Your company's ID: the `{companyId}` in every `/v0/companies/{companyId}/...` route.
The numeric id of the company (tenant) a resource belongs to.
companyNamestring
Your company's name. Null when your account belongs to no company.

Errors

401404500

Request

curl

curl https://api.hermeshealth.ai/v0/user-profile \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

response = requests.get(
    "https://api.hermeshealth.ai/v0/user-profile",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.hermeshealth.ai/v0/user-profile", {
    method: "GET",
    headers: {
        Authorization: "Bearer YOUR_API_KEY",
    },
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();

Response

json

{
  "id": "string",
  "email": "jane@example.com",
  "firstName": "string",
  "lastName": "string",
  "lastLogin": "2026-01-15T12:00:00Z",
  "createdAt": "2026-01-15T12:00:00Z",
  "updatedAt": "2026-01-15T12:00:00Z",
  "companyId": 115,
  "companyName": "string",
  "permissions": [
    "string"
  ]
}