HubSpot User Provisioning
Browse all Hubspot APIs55
AI ReadinessFoundational (C)55/100
Official vendor OpenAPI document · agent-readyIdentity AuthDirectory Servicesoauth2,apiKey7 EndpointsREST
For Agents
List HubSpot users, teams, and roles; provision new users; update an individual user's role; and offboard users from the portal.
Use for: I need to invite a new sales rep to HubSpot, Remove an offboarded employee from HubSpot, List all users on the HubSpot account, Get the role and team for a specific HubSpot user
Not supported: Does not configure SSO, set permission scopes, or manage app-level OAuth installs - use for HubSpot user, role, and team directory operations only.
The HubSpot User Provisioning API manages the user directory of a HubSpot account: who has a seat, what role they hold, and which team they belong to. It supports inviting and removing users, fetching the role and team rosters, and updating an individual user's role assignment. Identity providers and HRIS systems use it to keep HubSpot's seat allocation in sync as people join, change teams, or leave the company.
Install Jentic One Beta
Connect the HubSpot User Provisioning to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the HubSpot User Provisioning, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhubspot.com%2Fhubspot-user-provisioning" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhubspot.com%2Fhubspot-user-provisioning" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with HubSpot User Provisioning API.
List every user with a seat on the HubSpot account
Invite a new user to the HubSpot account with a specific role
Retrieve a single user record by user ID
Update a user's role assignment without recreating the user
Remove a user from the HubSpot account to revoke access
List the teams configured on the portal for assignment
List the roles available on the portal for assignment
Use Cases
Patterns agents use HubSpot User Provisioning API for, with concrete tasks.
★ HRIS to HubSpot user sync
Keep HubSpot's seat list aligned with the source-of-truth HR system by reading new joiners and leavers nightly and pushing them through this API. New hires receive an invite with the correct role, and offboarded users are removed the day they leave so revoked access is enforced without manual cleanup.
For each new joiner, POST /settings/v3/users/ with email and roleId; for each leaver, DELETE /settings/v3/users/{userId} to remove the seat.
Role rebalancing during a reorg
When sales territories or pods are restructured, update many users' role assignments at once without having to recreate accounts. Reading the role list first and patching each user keeps team membership and audit history intact while shifting permissions to the new structure.
Call GET /settings/v3/users/roles to find the new role IDs, then iterate over affected users with PUT /settings/v3/users/{userId} to set the new roleId.
Audit of HubSpot seat usage
Generate a periodic seat audit by listing every user and joining the result against the role and team rosters to surface seats that no longer match an active employee or that hold a role richer than required. Finance and security teams use the same join to confirm that paid seat counts match contract terms.
Call GET /settings/v3/users/, GET /settings/v3/users/roles, and GET /settings/v3/users/teams, then merge the records and flag any user whose role exceeds their job function.
Agent-driven onboarding through Jentic
An onboarding agent triggered by an HRIS new-hire event uses Jentic to find the HubSpot user invite operation, loads the schema, and provisions the seat with the right role and team. Jentic's vault holds the HubSpot OAuth token so the same agent can run safely against multiple HubSpot portals in a multi-tenant setup.
Through Jentic, search 'invite a HubSpot user', load the schema for POST /settings/v3/users/, and execute it with the new hire's email and the AE roleId.
Key Endpoints
7 endpoints — the hubspot user provisioning api manages the user directory of a hubspot account: who has a seat, what role they hold, and which team they belong to.
METHOD
PATH
DESCRIPTION
GET
/settings/v3/users/
List all users on the portal
POST
/settings/v3/users/
Invite a new user to the portal
GET
/settings/v3/users/{userId}
Retrieve a single user record
PUT
/settings/v3/users/{userId}
Update a user's role assignment
DELETE
/settings/v3/users/{userId}
Remove a user from the portal
GET
/settings/v3/users/roles
List available roles
GET
/settings/v3/users/teams
List configured teams
GET
/settings/v3/users/
List all users on the portal
POST
/settings/v3/users/
Invite a new user to the portal
GET
/settings/v3/users/{userId}
Retrieve a single user record
PUT
/settings/v3/users/{userId}
Update a user's role assignment
DELETE
/settings/v3/users/{userId}
Remove a user from the portal
GET
/settings/v3/users/roles
List available roles
GET
/settings/v3/users/teams
List configured teams
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
U
User Provisioning
- Foundational (C)55/100
73
Foundational Compliance69
Developer Experience & Jentic Compatibility29
AI-Readiness & Agent Experience94
Agent Usability70
Security68
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
73
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
94%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
69
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B+Signals: 4
35%
Example Density
How richly the API is illustrated with examples.
91%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
29
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
53%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
64%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
70
Security
Trust, risk posture, and security compliance.
Grade: A-Signals: 1
70%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
68
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
68%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring HubSpot User Provisioning by hand means running its OAuth flow or minting a private-app token, targeting api.hubapi.com, and mapping users to role and team ids yourself. Through Jentic you install once, import HubSpot User Provisioning from the API Directory, store the credential once, and your agent calls it.
Permission scoping
This API puts the user id in the URL path (/settings/v3/users/{userId}), so a rule can pin your agent to one user: it can read and update that user and nothing else. You choose the operations it may call, so deleting a user is not included unless you add it.
Credential isolation
Your HubSpot OAuth or private-app token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'invite a HubSpot user' or 'list HubSpot roles', and Jentic returns the matching User Provisioning operation with its input schema, including the userId and roleId fields, so the agent calls the right endpoint without browsing the HubSpot reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using HubSpot User Provisioning API through Jentic.
What authentication does the HubSpot User Provisioning API use?
It accepts HubSpot OAuth 2.0 tokens and private-app tokens passed as a Bearer header. Through Jentic the credential is held in your encrypted Jentic One instance and injected at execution time, so the agent provisioning users never sees the raw token.
Can I invite a user with a specific role and team?
Yes. POST /settings/v3/users/ accepts the email plus the roleId returned from GET /settings/v3/users/roles and the primary team from GET /settings/v3/users/teams, so invites land with the correct permissions from day one.
What are the rate limits for this API?
HubSpot's standard public API limits apply: 100 requests per 10 seconds for OAuth apps and 110 per 10 seconds for private apps. For nightly HRIS sync of large workforces, throttle the inviter loop to stay under that window.
How do I offboard a user through Jentic?
Search Jentic for 'remove a HubSpot user', load the schema for DELETE /settings/v3/users/{userId}, and execute it with the userId. The seat is freed and the user can no longer sign in to the portal.
Does this API replace SCIM provisioning?
It can - the create, update, and delete operations cover the lifecycle most identity providers need to drive HubSpot. Use this API when your IdP does not have a native HubSpot SCIM connector, or when you need finer control than the SCIM mapping allows.
Can I change a user's role without recreating the user?
Yes. PUT /settings/v3/users/{userId} updates the roleId in place, preserving the user's history, owned records, and login. Recreate the user only when the email itself needs to change.
Can I limit what my agent is allowed to do with the HubSpot User Provisioning API?
Yes. Jentic One runs self-hosted, so your own rules decide which of the seven operations the agent may call: you can allow it to list users, invite a user, or update a role while excluding DELETE /settings/v3/users/{userId} so it can never remove a seat. Because the user id sits in the path (/settings/v3/users/{userId}), a rule can pin the agent to a single user, letting it read and update only that record. The HubSpot OAuth or private-app token stays with your instance and is injected at call time, so the agent never handles the raw credential.
GET STARTED