How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Huma

Huma User API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Huma User API is one of 77 APIs that Huma publishes on the 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.

This API exposes 44 operations across 40 paths, and defines 145 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://workspace-gcp-uk.api.huma.com/api/integration/v1.

44 operations 40 paths 145 schemas 2 DELETE16 GET24 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://workspace-gcp-uk.api.huma.com/api/integration/v1
Authentication
API Key, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Huma User API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (Hawk_Auth). It accepts HTTP bearer tokens (JWT) (JWT_Auth). It accepts HTTP bearer tokens (JWT) (jwtAuth).

  • Hawk_Auth — Hawk MAC authentication. Paste a full Authorization header value. Example: Authorization: Hawk id="userId:clientId", ts=" ", nonce=" ", mac=" "[, hash=" "][, e…
  • JWT_Auth — Use HTTP Bearer auth with a JWT. Send the token in the Authorization header: Authorization: Bearer The token should contain standard claims plus projectId and…

Paths & Operations 44

Across 40 paths, the API surfaces 44 operations — 2 DELETE, 16 GET, 24 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

User 44
DELETE
/api/auth/v1/private/user/{user_id}/delete-user
Delete User
api_auth_v1_private_user_delete_user_destroy_[delete_user] 1 param
GET
/api/extensions/v1/user/{user_id}
Retrieve User Profile
api_extensions_v1_user_retrieve_[retrieve_user_profile] 1 param → 200
POST
/api/extensions/v1/user/{user_id}
Update User Profile
api_extensions_v1_user_create_[update_user_profile] 1 param body → 200
POST
/api/extensions/v1/user/{user_id}/add-role
Add Roles
api_extensions_v1_user_add_role_create_[add_roles] 1 param body → 200
POST
/api/extensions/v1/user/{user_id}/assign-proxy
Link Proxy User
api_extensions_v1_user_assign_proxy_create_[link_proxy_user] 1 param body → 201
PUT
/api/extensions/v1/user/{user_id}/clear/fields
Clear User Profile Data
api_extensions_v1_user_clear_fields_update_[clear_user_profile_data] 1 param body → 200
GET
/api/extensions/v1/user/{user_id}/configuration
Retrieve Deployment Config
api_extensions_v1_user_configuration_retrieve_[retrieve_deployment_config] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/consent/{consent_id}/sign
Sign Consent
api_extensions_v1_user_consent_sign_create_[sign_consent] 2 params body → 201
POST
/api/extensions/v1/user/{user_id}/deployment/{deployment_id}/helperagreementlog
Create Helper Agreement Log
api_extensions_v1_user_deployment_helperagreementlog_create_[create_helper_agreement_log] 2 params body → 201
GET
/api/extensions/v1/user/{user_id}/deployment/{deployment_id}/note/{note_id}
Retrieve Single User Note
api_extensions_v1_user_deployment_note_retrieve_[retrieve_single_user_note] 3 params → 200
GET
/api/extensions/v1/user/{user_id}/deployment/{deployment_id}/thumbnail-notes
Retrieve User Thumbnail Notes
api_extensions_v1_user_deployment_thumbnail_notes_retrieve_[retrieve_user_thumbnail_notes] 6 params → 200
GET
/api/extensions/v1/user/{user_id}/document
Retrieve Personal Documents
api_extensions_v1_user_document_retrieve_[retrieve_personal_documents] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/document
Create Personal Document
api_extensions_v1_user_document_create_[create_personal_document] 1 param body → 201
DELETE
/api/extensions/v1/user/{user_id}/document/{document_id}
Delete Personal Document
api_extensions_v1_user_document_destroy_[delete_personal_document] 2 params → 204
GET
/api/extensions/v1/user/{user_id}/econsent/{econsent_id}
Retrieve User Econsent
api_extensions_v1_user_econsent_retrieve_[retrieve_user_econsent] 2 params → 200
POST
/api/extensions/v1/user/{user_id}/econsent/{econsent_id}
Assign Econsent To User
api_extensions_v1_user_econsent_create_[assign_econsent_to_user] 2 params → 200
GET
/api/extensions/v1/user/{user_id}/econsent/{econsent_id}/pdf
Retrieve Econsent Pdf
api_extensions_v1_user_econsent_pdf_retrieve_[retrieve_econsent_pdf] 2 params → 200
POST
/api/extensions/v1/user/{user_id}/econsent/{econsent_id}/sign
Sign Econsent
api_extensions_v1_user_econsent_sign_create_[sign_econsent] 2 params body → 201
POST
/api/extensions/v1/user/{user_id}/econsent/{econsent_id}/withdraw
Withdraw Econsent
api_extensions_v1_user_econsent_withdraw_create_[withdraw_econsent] 2 params body → 200
GET
/api/extensions/v1/user/{user_id}/fullconfiguration
Retrieve Full Configuration For User
api_extensions_v1_user_fullconfiguration_retrieve_[retrieve_full_configuration_for_user] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/labels
Assign User Labels
api_extensions_v1_user_labels_create_[assign_user_labels] 1 param body → 200
POST
/api/extensions/v1/user/{user_id}/move/{target_deployment_id}
Move User
api_extensions_v1_user_move_create_[move_user] 2 params body → 200
PUT
/api/extensions/v1/user/{user_id}/move/ack/{acknowledge_id}
Acknowledge Move
api_extensions_v1_user_move_ack_update_[acknowledge_move] 2 params → 200
GET
/api/extensions/v1/user/{user_id}/move/history
Retrieve Move User History
api_extensions_v1_user_move_history_retrieve_[retrieve_move_user_history] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/offboard
Off Board User
api_extensions_v1_user_offboard_create_[off_board_user] 1 param → 200
GET
/api/extensions/v1/user/{user_id}/profiles/assigned
Retrieve Profiles With Assigned Manager With User Id
api_extensions_v1_user_profiles_assigned_retrieve_[retrieve_profiles_with_assigned_manager_with_user_id] 1 param → 200
GET
/api/extensions/v1/user/{user_id}/proxy-invitations
Retrieve Proxy Invitations
api_extensions_v1_user_proxy_invitations_retrieve_[retrieve_proxy_invitations] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/reactivate
Reactivate User
api_extensions_v1_user_reactivate_create_[reactivate_user] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/remove-role
Remove Roles
api_extensions_v1_user_remove_role_create_[remove_roles] 1 param body → 204
GET
/api/extensions/v1/user/{user_id}/resources
Retrieve User Resources
api_extensions_v1_user_resources_retrieve_[retrieve_user_resources] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/unassign-proxy
Unlink Proxy User
api_extensions_v1_user_unassign_proxy_create_[unlink_proxy_user] 1 param body → 204
POST
/api/extensions/v1/user/add-role
Add Roles To Users
api_extensions_v1_user_add_role_create_[add_roles_to_users] body → 200
POST
/api/extensions/v1/user/analytics
Retrieve Analytics Url
api_extensions_v1_user_analytics_create_[retrieve_analytics_url] body → 200
POST
/api/extensions/v1/user/assign
Assign Managers To Users
api_extensions_v1_user_assign_create_[assign_managers_to_users] body → 201
POST
/api/extensions/v1/user/labels
Assign Labels To Users
api_extensions_v1_user_labels_create_[assign_labels_to_users] body → 200
GET
/api/extensions/v1/user/lookup/{code}
Lookup User By Code
api_extensions_v1_user_lookup_retrieve_[lookup_user_by_code] 1 param → 200
GET
/api/extensions/v1/user/move/users
Retrieve Moved Users
api_extensions_v1_user_move_users_retrieve_[retrieve_moved_users] 1 param → 200
POST
/api/extensions/v1/user/offboard
Offboard Users
api_extensions_v1_user_offboard_create_[offboard_users] body → 200
POST
/api/extensions/v1/user/profiles
Retrieve User Profiles V1
api_extensions_v1_user_profiles_create_[retrieve_user_profiles_v1] body → 200
GET
/api/extensions/v1/user/profiles/assigned
Retrieve Profiles With Assigned Manager
api_extensions_v1_user_profiles_assigned_retrieve_[retrieve_profiles_with_assigned_manager] → 200
POST
/api/extensions/v1/user/reactivate
Reactivate Users
api_extensions_v1_user_reactivate_create_[reactivate_users] body → 200
POST
/api/extensions/v1/user/staff
Retrieve Staff List
api_extensions_v1_user_staff_create_[retrieve_staff_list] body → 200
GET
/api/extensions/v2/user/{user_id}/deployment/{deployment_id}/notes
Retrieve User Notes
api_extensions_v2_user_deployment_notes_retrieve_[retrieve_user_notes] 4 params → 200
POST
/api/extensions/v2/user/{user_id}/deployment/{deployment_id}/notes
Add User Notes
api_extensions_v2_user_deployment_notes_create_[add_user_notes] 2 params body → 201

Schemas 145

The contract defines 145 schemas that model the data the API accepts and returns. The most detailed are MovedUserDRF (80 properties), UserDTODRF (79 properties), RetrieveDeploymentConfigResponseObjectDRF (64 properties), DeploymentConfigDRF (57 properties). Each schema is shown below with its type and property counts.

ExtraDRF
object
3 properties 2 required
OffBoardingReasonsDRF
object
2 properties
UIWidgetDRF
object
5 properties 3 required
OrganizationDTODRF
object
24 properties
DeploymentStatsDRF
object
6 properties
UpdateUserProfileRequestDataDRF
object
47 properties
ModuleConfigDRF
object
25 properties 1 required
SurgeryDetailItemDRF
object
3 properties 2 required
RecentFlagsDRF
object
4 properties
AssignManagersToUsersRequestDataDRF
object
3 properties 1 required
EConsentLogDTODRF
object
19 properties 2 required
UserStatsDRF
object
2 properties
FeaturesDRF
object
30 properties
SsoDRF
object
3 properties
QuestionnaireAnswerMediaFileDRF
object
3 properties 2 required
UserMoveHistoryDTODRF
object
13 properties 1 required
SurgeryDetailsDRF
object
3 properties
RetrieveUserNotesV2ResponseDRF
object
4 properties
CreateHelperAgreementLogRequestDataDRF
object
1 property 1 required
PAMIntegrationConfigDRF
object
5 properties 5 required
AddUserNotesV2RequestDataDRF
object
2 properties 1 required
UserNoteDTODRF
object
14 properties
ProfileIdentifiersResponseObjectDRF
object
2 properties 2 required
UnseenFlagsDRF
object
4 properties
ManagerNotificationsDRF
object
1 property
UITabDRF
object
13 properties 5 required
SortParametersDRF
object
4 properties
DeploymentLevelConfigurationDRF
object
4 properties
DeviceIntegrationDRF
object
1 property
IntercomSettingsDRF
object
4 properties
FileFieldDRF
object
1 property 1 required
UserLabelDRF
object
3 properties
AssignUsersResponseDRF
object
1 property
AddRolesToUsersRequestDataDRF
object
3 properties 1 required
AssignLabelsToUserRequestDataDRF
object
1 property 1 required
ReactivateUsersRequestDataDRF
object
1 property 1 required
PeriodProgressDRF
object
5 properties
LabelDRF
object
8 properties
AddRolesToUserResponseDRF
object
1 property
RetrieveFullConfigurationResponseObjectDRF
object
3 properties 2 required
BackgroundDRF
object
2 properties 2 required
PassedDueDateEventsAmountDRF
object
2 properties
SdkConfigDRF
object
5 properties
ThresholdRangeDRF
object
3 properties
OffboardUsersResponseDRF
object
1 property
IntegrationDeviceDRF
object
7 properties 2 required
KeyActionConfigDRF
object
18 properties 4 required
SsoInfoDRF
object
16 properties 4 required
SignConsentRequestDataDRF
object
9 properties
BuilderDRF
object
1 property
QuestionnaireAnswerDRF
object
22 properties 1 required
UnlinkProxyRequestDataDRF
object
1 property 1 required
PatientPersonalizationDRF
object
2 properties
EmailTemplateDRF
object
3 properties 2 required
DeviceManufacturerDRF
object
4 properties 1 required
RetrieveProfilesRequestDataDRF
object
13 properties
ConsentDRF
object
13 properties 1 required
DeploymentInfoDRF
object
5 properties 2 required
AdditionalContactDetailsDRF
object
5 properties
AssignLabelsToUsersRequestDataDRF
object
2 properties 2 required
TaskComplianceDRF
object
5 properties
DeploymentConfigDRF
object
57 properties
MoveUserReasonsDRF
object
2 properties
AuthorisedRepDRF
object
4 properties 4 required
StaticEventDRF
object
4 properties 3 required
SecurityDRF
object
2 properties 2 required
OffBoardUsersRequestDataDRF
object
2 properties 2 required
FootnoteDRF
object
3 properties
OnboardingModuleConfigDTODRF
object
15 properties 2 required
FeedbackTextsDRF
object
2 properties
GenderOptionTypeDRF
object
3 properties 2 required
StudyProgressDRF
object
5 properties
S3ObjectDRF
object
3 properties 2 required
SummaryReportDRF
object
1 property
UnreadMessagesCountDRF
object
2 properties
ConsentSignatureDRF
object
7 properties 4 required
RetrieveAnalyticsResponseDRF
object
1 property
WithdrawEConsentRequestBodyDRF
object
1 property 1 required
RetrieveProxyInvitationsResponseObjectDRF
object
3 properties 1 required
AdditionalConsentQuestionDRF
object
7 properties 4 required
AddRolesInputDRF
object
4 properties 2 required
MessagingDRF
object
5 properties
ModuleGoalCreatedByDRF
object
2 properties
RetrieveDeploymentConfigResponseObjectDRF
object
64 properties
LocationDRF
object
9 properties
ReasonDRF
object
3 properties 2 required
EmailConfigDRF
object
2 properties
RagThresholdDRF
object
8 properties 6 required
MovedUserDRF
object
80 properties
SeverityFilterDRF
object
2 properties 2 required
RetrieveUserResourcesResponseObjectDRF
object
2 properties
SeenResultDataDRF
object
5 properties
FeedbackTextDRF
object
3 properties 2 required
ResearchTeamActionsDRF
object
1 property
ListIdResponseObjectDRF
object
1 property
ConsentReviewDRF
object
3 properties 2 required
LinkProxyUserResponseObjectDRF
object
1 property 1 required
SurgeryDetailDRF
object
4 properties 2 required
ResultIdResponseObjectDRF
object
1 property
DeploymentDTODRF
object
56 properties
LinkProxyRequestDataDRF
object
1 property 1 required
ClinicianOnlyFieldsDRF
object
1 property
ProfileFieldsDRF
object
31 properties
IntegrationConfigDRF
object
1 property
ProfileExtraIdsDRF
object
8 properties
RetrieveStaffRequestDataDRF
object
6 properties
AdditionalContactDetailsItemDRF
object
6 properties
StaticEventConfigDRF
object
3 properties 2 required
ConfigurationRoleDRF
object
7 properties
StatDRF
object
2 properties 1 required
ModuleScheduleDRF
object
6 properties
LearnSectionDRF
object
7 properties
CreatePersonalDocumentRequestDataDRF
object
3 properties 3 required
BoardingStatusDRF
object
5 properties 1 required
EConsentSectionDRF
object
11 properties 2 required
LearnDRF
object
5 properties
ProfileDRF
object
3 properties
RetrieveAnalyticsUrlRequestObjectDRF
object
5 properties 2 required
MoveUserRequestDataDRF
object
1 property 1 required
FeedbackConfigDRF
object
9 properties 1 required
FeedBacksGroupedByRagDRF
object
2 properties 2 required
ConsentSectionOptionsDRF
object
5 properties 2 required
ConsentSectionDRF
object
6 properties 1 required
ReactivateUsersResponseDRF
object
1 property
PersonalDocumentDRF
object
6 properties 3 required
FeedbackNotificationDataDRF
object
5 properties
RoleDTODRF
object
5 properties
MoveUserDetailsDRF
object
6 properties 5 required
ProxyDataDRF
object
4 properties
ClearUserProfileDataRequestDataDRF
object
1 property 1 required
SurgeryDateRuleDRF
object
2 properties
RetrieveMoveUserHistoryResponseObjectDRF
object
1 property
EConsentDRF
object
16 properties 5 required
RetrieveProfilesResponseObjectDRF
object
3 properties 3 required
NotificationDataDRF
object
4 properties
RoleAssignmentDTODRF
object
4 properties 2 required
UserSurgeryDetailsDRF
object
3 properties
LearnArticleDRF
object
9 properties 2 required
EthnicityOptionDRF
object
3 properties 2 required
VariabilityFilterDRF
object
4 properties
LearnArticleContentDRF
object
12 properties 1 required
ModuleGoalDTODRF
object
9 properties
UserDTODRF
object
79 properties
SignEConsentRequestDataDRF
object
10 properties
AddressObjectDRF
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huma-user-api-openapi.yml Raw ↑

Other APIs Huma publishes across the network.

Huma Mobile & Web SDK
AE Profile APIs.io
Huma AI Engine API
AE Profile APIs.io
Huma Appointment API
AE Profile APIs.io
Huma Assets API
AE Profile APIs.io
Huma Audit Log API
AE Profile APIs.io
Huma Auth API
AE Profile APIs.io
Huma Authorization Admin API
AE Profile APIs.io
Huma Autocomplete API
AE Profile APIs.io
Huma Billing API
AE Profile APIs.io
Huma Billing Portal Route API
AE Profile APIs.io
Huma Builder API
AE Profile APIs.io
Huma Calendar Route API
AE Profile APIs.io
#User
← Back to H APIs
API Details
ID
huma:huma-user-api
Base URL
https://workspace-gcp-uk.api.huma.com/api/integration/v1
Docs
https://docs.huma.com/api-integration/intro
Provider
Huma
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=huma-user-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/huma-user-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Huma User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.