Users
Users belong to one or more organizations. Roles include developer, clinician, admin, and viewer.
The User Object
| Field | Type | Description |
|---|---|---|
| id | string | Unique user ID with prefix usr_ (e.g. usr_8hq3zk) |
| string | Primary email address used for authentication and notifications | |
| name | string | Full display name of the user |
| role | string | One of: developer, clinician, admin, viewer |
| npinullable | string | 10-digit National Provider Identifier (clinicians only) |
| active | boolean | Whether the user account is active. Deactivated users cannot authenticate |
| createdAt | datetime | ISO 8601 UTC timestamp when the user was created |
Endpoints
Returns all users in the authenticated organization.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| rolee.g. clinician | query | string | optional | Filter by role (developer|clinician|admin|viewer) |
| limite.g. 50 | query | integer | optional | Max records to return |
Request
curl "https://api.healthcloud.ai/v1/users?role=clinician" \ -H "Authorization: Bearer hc_test_sk_demo_live_xxxxxx"
Response
Response200
{ "data": [ { "id": "usr_8hq3zk", "email": "sarah.chen@stmercy.org", "name": "Dr. Sarah Chen", "role": "clinician", "npi": "1234567890", "active": true } ], "meta": { "total": 42, "cursor": "usr_9ar4al" } }