Huma

Huma User API

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

GitHub OpenAPI

Operations 44

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 #
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}/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/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 #

Documentation

📖
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/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-user-api-openapi.yml

Other Resources

🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/huma-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

huma-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Huma Platform User API
  version: 1.0.0
  description: Huma Platform
servers:
- url: https://workspace-gcp-uk.api.huma.com/api/integration/v1
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:


# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-user-api-openapi.yml