# Huma User API

**Canonical:** https://apis.io/apis/huma/huma-user-api/  
**Provider:** Huma — https://apis.io/providers/huma/  
**Base URL:** https://workspace-gcp-uk.api.huma.com/api/integration/v1  
**Documentation:** https://docs.huma.com/api-integration/intro

Huma User API is one of 77 APIs that [Huma](https://apis.io/providers/huma/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

The User API from Huma — 40 operation(s) for user.

## Operations (44)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/api/auth/v1/private/user/{user_id}/delete-user` | Delete User |
| GET | `/api/extensions/v1/user/{user_id}` | Retrieve User Profile |
| POST | `/api/extensions/v1/user/{user_id}` | Update User Profile |
| POST | `/api/extensions/v1/user/{user_id}/add-role` | Add Roles |
| POST | `/api/extensions/v1/user/{user_id}/assign-proxy` | Link Proxy User |
| PUT | `/api/extensions/v1/user/{user_id}/clear/fields` | Clear User Profile Data |
| GET | `/api/extensions/v1/user/{user_id}/configuration` | Retrieve Deployment Config |
| POST | `/api/extensions/v1/user/{user_id}/consent/{consent_id}/sign` | Sign Consent |
| POST | `/api/extensions/v1/user/{user_id}/deployment/{deployment_id}/helperagreementlog` | Create Helper Agreement Log |
| GET | `/api/extensions/v1/user/{user_id}/deployment/{deployment_id}/note/{note_id}` | Retrieve Single User Note |
| GET | `/api/extensions/v1/user/{user_id}/deployment/{deployment_id}/thumbnail-notes` | Retrieve User Thumbnail Notes |
| GET | `/api/extensions/v1/user/{user_id}/document` | Retrieve Personal Documents |
| POST | `/api/extensions/v1/user/{user_id}/document` | Create Personal Document |
| DELETE | `/api/extensions/v1/user/{user_id}/document/{document_id}` | Delete Personal Document |
| GET | `/api/extensions/v1/user/{user_id}/econsent/{econsent_id}` | Retrieve User Econsent |
| POST | `/api/extensions/v1/user/{user_id}/econsent/{econsent_id}` | Assign Econsent To User |
| GET | `/api/extensions/v1/user/{user_id}/econsent/{econsent_id}/pdf` | Retrieve Econsent Pdf |
| POST | `/api/extensions/v1/user/{user_id}/econsent/{econsent_id}/sign` | Sign Econsent |
| POST | `/api/extensions/v1/user/{user_id}/econsent/{econsent_id}/withdraw` | Withdraw Econsent |
| GET | `/api/extensions/v1/user/{user_id}/fullconfiguration` | Retrieve Full Configuration For User |
| POST | `/api/extensions/v1/user/{user_id}/labels` | Assign User Labels |
| POST | `/api/extensions/v1/user/{user_id}/move/{target_deployment_id}` | Move User |
| PUT | `/api/extensions/v1/user/{user_id}/move/ack/{acknowledge_id}` | Acknowledge Move |
| GET | `/api/extensions/v1/user/{user_id}/move/history` | Retrieve Move User History |
| POST | `/api/extensions/v1/user/{user_id}/offboard` | Off Board User |
| GET | `/api/extensions/v1/user/{user_id}/profiles/assigned` | Retrieve Profiles With Assigned Manager With User Id |
| GET | `/api/extensions/v1/user/{user_id}/proxy-invitations` | Retrieve Proxy Invitations |
| POST | `/api/extensions/v1/user/{user_id}/reactivate` | Reactivate User |
| POST | `/api/extensions/v1/user/{user_id}/remove-role` | Remove Roles |
| GET | `/api/extensions/v1/user/{user_id}/resources` | Retrieve User Resources |
| POST | `/api/extensions/v1/user/{user_id}/unassign-proxy` | Unlink Proxy User |
| POST | `/api/extensions/v1/user/add-role` | Add Roles To Users |
| POST | `/api/extensions/v1/user/analytics` | Retrieve Analytics Url |
| POST | `/api/extensions/v1/user/assign` | Assign Managers To Users |
| POST | `/api/extensions/v1/user/labels` | Assign Labels To Users |
| GET | `/api/extensions/v1/user/lookup/{code}` | Lookup User By Code |
| GET | `/api/extensions/v1/user/move/users` | Retrieve Moved Users |
| POST | `/api/extensions/v1/user/offboard` | Offboard Users |
| POST | `/api/extensions/v1/user/profiles` | Retrieve User Profiles V1 |
| GET | `/api/extensions/v1/user/profiles/assigned` | Retrieve Profiles With Assigned Manager |
| POST | `/api/extensions/v1/user/reactivate` | Reactivate Users |
| POST | `/api/extensions/v1/user/staff` | Retrieve Staff List |
| GET | `/api/extensions/v2/user/{user_id}/deployment/{deployment_id}/notes` | Retrieve User Notes |
| POST | `/api/extensions/v2/user/{user_id}/deployment/{deployment_id}/notes` | Add User Notes |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-user-api-openapi.yml
- **APIReference** — https://workspace-gcp-uk.api.huma.com/docs
- **Documentation** — https://docs.huma.com/api-integration/intro
- **GettingStarted** — https://docs.huma.com/quick-start/backend/
- **Authentication** — https://docs.huma.com/quick-start/backend/
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/errors/huma-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/data-model/huma-data-model.yml

## Other Huma APIs (12)

- [Huma Mobile & Web SDK](https://apis.io/apis/huma/huma-mobile-sdk/)
- [Huma AI Engine API](https://apis.io/apis/huma/huma-ai-engine-api/)
- [Huma Appointment API](https://apis.io/apis/huma/huma-appointment-api/)
- [Huma Assets API](https://apis.io/apis/huma/huma-assets-api/)
- [Huma Audit Log API](https://apis.io/apis/huma/huma-audit-log-api/)
- [Huma Auth API](https://apis.io/apis/huma/huma-auth-api/)
- [Huma Authorization Admin API](https://apis.io/apis/huma/huma-authorization-admin-api/)
- [Huma Autocomplete API](https://apis.io/apis/huma/huma-autocomplete-api/)
- [Huma Billing API](https://apis.io/apis/huma/huma-billing-api/)
- [Huma Billing Portal Route API](https://apis.io/apis/huma/huma-billing-portal-route-api/)
- [Huma Builder API](https://apis.io/apis/huma/huma-builder-api/)
- [Huma Calendar Route API](https://apis.io/apis/huma/huma-calendar-route-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/huma/huma-user-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/huma/.