Huma Deployment API is one of 77 APIs that Huma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deployment. 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
66 operations
across 52 paths,
and defines 139 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.
66 operations52 paths139 schemas8 DELETE15 GET29 POST14 PUT
Metadata
The identity and technical contract details declared by the specification.
Huma Deployment 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 66
Across 52 paths, the API surfaces 66 operations — 8 DELETE, 15 GET, 29 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 139 schemas that model the data the API accepts and returns. The most detailed are DeploymentResponseObjectDRF (59 properties), DeploymentDTODRF (56 properties), CreateDeploymentRequestObjectDRF (56 properties), CreateFullDeploymentRequestObjectDRF (56 properties). Each schema is shown below with its type and property counts.
MoveDeploymentsRequestObjectBodyDRF
object
3 properties3 required
OffBoardingReasonsDRF
object
2 properties
UIWidgetDRF
object
5 properties3 required
DeploymentStatsDRF
object
6 properties
RetrieveDeploymentLabelsResponseObjectDRF
object
9 properties1 required
RollbackRequestBodyDRF
object
1 property1 required
ModuleConfigDRF
object
25 properties1 required
SurgeryDetailItemDRF
object
3 properties2 required
RetrieveDeploymentKeyActionsResponseObjectDRF
object
1 property
DeploymentResponseObjectDRF
object
59 properties
FullDeploymentLearnDRF
object
5 properties
CreateLearnSectionRequestObjectDRF
object
7 properties
FeaturesDRF
object
30 properties
SsoDRF
object
3 properties
UpdateModuleConfigRequestObjectDRF
object
24 properties1 required
SurgeryDetailsDRF
object
3 properties
ConsentResponseObjectDRF
object
13 properties1 required
PAMIntegrationConfigDRF
object
5 properties5 required
ComponentConfigRequestBodyDRF
object
2 properties1 required
DeviceConnectionDRF
object
6 properties
UITabDRF
object
13 properties5 required
OrgInfoDRF
object
2 properties
DeploymentLevelConfigurationDRF
object
4 properties
DeviceIntegrationDRF
object
1 property
LocalizationSchemaDRF
object
20 properties
SendMessageToPatientListRequestObjectBodyDRF
object
4 properties2 required
LabelDRF
object
8 properties
CreateFullOnboardingConfigRequestObjectDRF
object
15 properties2 required
BackgroundDRF
object
2 properties2 required
SdkConfigDRF
object
5 properties
ThresholdRangeDRF
object
3 properties
ArticleDRF
object
8 properties1 required
IntegrationDeviceDRF
object
7 properties2 required
SearchCMSArticlesResponseDRF
object
3 properties3 required
KeyActionConfigDRF
object
18 properties4 required
BuilderDRF
object
1 property
SsoInfoDRF
object
16 properties4 required
EmailTemplateDRF
object
3 properties2 required
PatientPersonalizationDRF
object
2 properties
DeviceManufacturerDRF
object
4 properties1 required
CreateConsentRequestObjectDRF
object
13 properties1 required
ConsentDRF
object
13 properties1 required
MoveUserReasonsDRF
object
2 properties
AuthorisedRepDRF
object
4 properties4 required
StaticEventDRF
object
4 properties3 required
SecurityDRF
object
2 properties2 required
FootnoteDRF
object
3 properties
OnboardingModuleConfigDTODRF
object
15 properties2 required
FeedbackTextsDRF
object
2 properties
GenderOptionTypeDRF
object
3 properties2 required
S3ObjectDRF
object
3 properties2 required
SummaryReportDRF
object
1 property
CreateFullDeploymentLearnSectionRequestObjectDRF
object
7 properties
ModuleSchemaDRF
object
2 properties
CreateLearnArticleRequestObjectDRF
object
9 properties2 required
UsersInfoDRF
object
2 properties1 required
ConsentSignatureDRF
object
7 properties4 required
AddFilesToLibraryRequestObjectBodyDRF
object
3 properties2 required
ReleaseDRF
object
4 properties
AdditionalConsentQuestionDRF
object
7 properties4 required
RetrieveDeploymentsResponseObjectDRF
object
5 properties
ModuleGoalCreatedByDRF
object
2 properties
MessagingDRF
object
5 properties
BasePhoenixDynamicConfigDRF
object
2 properties
LocationDRF
object
9 properties
CreateFullKeyActionConfigRequestObjectDRF
object
18 properties4 required
ReasonDRF
object
3 properties2 required
DeploymentRoleUpdateObjectBodyDRF
object
1 property
EmailConfigDRF
object
2 properties
RagThresholdDRF
object
8 properties6 required
RetrieveFilesInLibraryResponseObjectDRF
object
2 properties
EncryptValueRequestObjectBodyDRF
object
1 property1 required
SeverityFilterDRF
object
2 properties2 required
FeedbackTextDRF
object
3 properties2 required
ListIdResponseObjectDRF
object
1 property
CreateKeyActionConfigRequestObjectDRF
object
18 properties4 required
ConsentReviewDRF
object
3 properties2 required
RetrieveLocalizableFieldsResponseObjectDRF
object
1 property
SurgeryDetailDRF
object
4 properties2 required
RetrieveDeploymentKeyActionsRequestObjectBodyDRF
object
3 properties2 required
ResultIdResponseObjectDRF
object
1 property
UpdateLabelRequestObjectBodyDRF
object
1 property1 required
DeploymentDTODRF
object
56 properties
ClinicianOnlyFieldsDRF
object
1 property
ProfileFieldsDRF
object
31 properties
EncryptValueResponseObjectDRF
object
1 property
CreateEConsentRequestObjectDRF
object
16 properties5 required
IntegrationConfigDRF
object
1 property
ProfileExtraIdsDRF
object
8 properties
AdditionalContactDetailsItemDRF
object
6 properties
StaticEventConfigDRF
object
3 properties2 required
SearchResultDRF
object
6 properties1 required
StatDRF
object
2 properties1 required
RetrieveDeploymentTemplatesResponseObjectDRF
object
1 property
ModuleScheduleDRF
object
6 properties
LearnSectionDRF
object
7 properties
VersionsResponseObjectDRF
object
1 property
SendMessageToUserListResponseObjectDRF
object
1 property
EConsentSectionDRF
object
11 properties2 required
LearnDRF
object
5 properties
ProfileDRF
object
3 properties
FeedbackConfigDRF
object
9 properties1 required
OrderUpdateObjectDRF
object
2 properties2 required
FeedBacksGroupedByRagDRF
object
2 properties2 required
ConsentSectionOptionsDRF
object
5 properties2 required
DeploymentEventDRF
object
10 properties
DeviceCategoriesDRF
object
1 property
UpdateDeploymentRequestBodyDRF
object
55 properties
ConsentSectionDRF
object
6 properties1 required
LibraryFileObjectDRF
object
5 properties
FeedbackNotificationDataDRF
object
5 properties
DeploymentTemplateDTODRF
object
10 properties3 required
RoleDTODRF
object
5 properties
ValidateQuestionnaireDimensionsRequestObjectDRF
object
1 property1 required
CreateLabelsRequestObjectBodyDRF
object
1 property1 required
PublishDeploymentRequestBodyDRF
object
1 property
SurgeryDateRuleDRF
object
2 properties
GenerateMasterTranslationsResponseObjectDRF
object
1 property
CreateFullDeploymentRequestObjectDRF
object
56 properties
EConsentDRF
object
16 properties5 required
NotificationDataDRF
object
4 properties
SortFieldDRF
object
2 properties2 required
LearnArticleDRF
object
9 properties2 required
SendEmailToPatientsRequestObjectDRF
object
4 properties2 required
ImportLocalizationsRequestObjectDRF
object
4 properties3 required
EthnicityOptionDRF
object
3 properties2 required
VariabilityFilterDRF
object
4 properties
CreateModuleConfigRequestObjectDRF
object
24 properties1 required
ReleasesResponseObjectDRF
object
1 property
LearnArticleContentDRF
object
12 properties1 required
CreateDeploymentRequestObjectDRF
object
56 properties
OkResponseDRF
object
1 property
RetrieveLocalizationsRequestObjectDRF
object
2 properties1 required
DeviceConnectionIdDRF
object
1 property1 required
EConsentResponseObjectDRF
object
16 properties5 required
ModuleGoalDTODRF
object
9 properties
RetrieveDeploymentsRequestObjectDRF
object
8 properties
CreateMultipleModuleConfigsRequestObjectBodyDRF
object
1 property1 required
DeviceCategoryDRF
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Deployment 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.