HubSpot CRM Schemas
Browse all Hubspot APIs61
AI ReadinessAI-Aware (B-)61/100
Official vendor OpenAPI document · agent-readyCRMContact Managementoauth27 EndpointsREST
For Agents
Define and manage HubSpot custom object schemas - properties, primary display, and associations - so an agent can model bespoke CRM data structures and link them to standard objects.
Use for: I need to define a custom object schema for tracking equipment in HubSpot, Add a new property to an existing custom object schema, List all custom object schemas configured in this HubSpot portal, Create an association between my Equipment custom object and the Companies object
Not supported: Does not handle individual record CRUD, property values, or workflow automation - use for defining custom object types, their properties, and their schema-level associations only.
The HubSpot CRM Schemas API defines how custom objects store and represent information in the HubSpot CRM. A schema describes an object type's properties, primary display property, secondary display properties, searchable properties, required fields, and supported associations to other CRM objects. The API exposes operations to list all schemas, create a new schema for a custom object, fetch or update an existing schema by objectType, delete a schema, and add or remove associations between schemas - making it the foundation for any HubSpot integration that goes beyond the standard contact, company, deal, ticket, and quote objects.
Install Jentic One Beta
Connect the HubSpot CRM Schemas to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the HubSpot CRM Schemas, 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-crm-schemas" | 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-crm-schemas" | 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 CRM Schemas API.
List every custom object schema in the portal with GET /crm-object-schemas/v3/schemas
Define a new custom object schema including properties and required fields via POST /crm-object-schemas/v3/schemas
Read the current definition of a schema by objectType using GET /crm-object-schemas/v3/schemas/{objectType}
Evolve a schema with additional properties or display rules using PATCH /crm-object-schemas/v3/schemas/{objectType}
Add an association between two custom object schemas with POST /crm-object-schemas/v3/schemas/{objectType}/associations
Remove a schema-level association via DELETE /crm-object-schemas/v3/schemas/{objectType}/associations/{associationIdentifier}
Delete an obsolete schema with DELETE /crm-object-schemas/v3/schemas/{objectType}
Use Cases
Patterns agents use HubSpot CRM Schemas API for, with concrete tasks.
★ Modelling Industry-Specific Data With Custom Objects
When standard HubSpot objects (contacts, companies, deals, tickets) cannot represent industry-specific entities - like loans for a lender, vehicles for a dealership, or properties for a real-estate firm - teams use the Schemas API to define custom objects with the exact properties and display rules they need. Defining a schema is a one-time setup; once created, custom objects behave like standard objects with full CRUD, search, and association support across HubSpot.
Call POST /crm-object-schemas/v3/schemas with name, labels, primaryDisplayProperty, requiredProperties, and a properties array defining each field for the new custom object.
Schema Evolution as Business Requirements Change
Business processes change, and existing custom objects need new fields or relationships over time. The Schemas API supports incremental updates via PATCH /crm-object-schemas/v3/schemas/{objectType} so engineers can add properties or update display configuration without recreating the schema. Combined with the associations endpoints, teams can also wire up new relationships (e.g., link a custom Project object to Deals) when the business model expands.
Call PATCH /crm-object-schemas/v3/schemas/{objectType} with an object containing the new property definitions and any updated display configuration.
Connecting Custom Objects to Standard CRM Records
Custom objects are most useful when they relate to standard records - for example, a custom Subscription object linked to Companies and Deals so renewal data shows up in the right CRM views. POST /crm-object-schemas/v3/schemas/{objectType}/associations creates these schema-level associations, which then become available for object-level association calls. DELETE on the same path with an associationIdentifier tears the link down when needed.
Call POST /crm-object-schemas/v3/schemas/p_subscription/associations with fromObjectTypeId='p_subscription' and toObjectTypeId='0-2' to associate a Subscription custom object with Companies.
AI Agent Bootstrapping a New HubSpot Tenant
An onboarding agent provisions a fresh HubSpot portal for a new customer by reading their data model from a config file and creating each custom object schema in turn. Through Jentic the agent searches for schema operations, loads the create and association schemas, and executes them in dependency order. Jentic stores the OAuth credentials in its vault so the agent only sees scoped execution tokens.
Search Jentic for 'create hubspot custom object schema', load the operation, and execute POST /crm-object-schemas/v3/schemas for each entry in the customer's data model config.
Key Endpoints
7 endpoints — the hubspot crm schemas api defines how custom objects store and represent information in the hubspot crm.
METHOD
PATH
DESCRIPTION
GET
/crm-object-schemas/v3/schemas
List all custom object schemas
POST
/crm-object-schemas/v3/schemas
Create a new custom object schema
GET
/crm-object-schemas/v3/schemas/{objectType}
Get a schema by objectType
PATCH
/crm-object-schemas/v3/schemas/{objectType}
Update a schema
DELETE
/crm-object-schemas/v3/schemas/{objectType}
Delete a schema
POST
/crm-object-schemas/v3/schemas/{objectType}/associations
Create an association between schemas
DELETE
/crm-object-schemas/v3/schemas/{objectType}/associations/{associationIdentifier}
Remove a schema association
GET
/crm-object-schemas/v3/schemas
List all custom object schemas
POST
/crm-object-schemas/v3/schemas
Create a new custom object schema
GET
/crm-object-schemas/v3/schemas/{objectType}
Get a schema by objectType
PATCH
/crm-object-schemas/v3/schemas/{objectType}
Update a schema
DELETE
/crm-object-schemas/v3/schemas/{objectType}
Delete a schema
POST
/crm-object-schemas/v3/schemas/{objectType}/associations
Create an association between schemas
DELETE
/crm-object-schemas/v3/schemas/{objectType}/associations/{associationIdentifier}
Remove a schema association
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.
H
HubSpot CRM Schemas
- AI-Aware (B-)61/100
73
Foundational Compliance72
Developer Experience & Jentic Compatibility33
AI-Readiness & Agent Experience94
Agent Usability90
Security100
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
93%
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.
72
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
43%
Example Density
How richly the API is illustrated with examples.
94%
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.
33
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
69%
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.
90
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
90%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
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 CRM Schemas by hand means learning its OAuth2 access token auth with the crm.schemas scopes, targeting the api.hubapi.com host, and shaping object-type and association payloads yourself. Through Jentic you install once, import HubSpot CRM Schemas from the API Directory, store the token once, and your agent calls it.
Permission scoping
The Schemas API puts the object type in the URL path (/crm-object-schemas/v3/schemas/{objectType}), so a rule can pin your agent to one object type for reads and edits. You choose the operations it may call, so destructive ones like deleting a schema or removing an association are not included unless you add them.
Credential isolation
Your HubSpot access 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 'create a HubSpot custom object schema' or 'add a schema association', and Jentic returns the matching Schemas operation with its input schema so the agent models new object types without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using HubSpot CRM Schemas API through Jentic.
What authentication does the HubSpot CRM Schemas API use?
It uses OAuth 2.0 with the crm.schemas.custom.read and crm.schemas.custom.write scopes, passed as a Bearer token in the Authorization header. Through Jentic the OAuth token is stored encrypted in the vault and injected at execution time so the agent never holds the raw secret.
Can I add a new property to an existing custom object with the Schemas API?
Yes. PATCH /crm-object-schemas/v3/schemas/{objectType} accepts a body that adds new property definitions to the schema. Property name, label, type, and groupName are required for each new property.
What are the rate limits for the HubSpot CRM Schemas API?
HubSpot enforces 100 requests per 10 seconds for OAuth apps and 190 per 10 seconds for private apps on Enterprise tiers, plus daily quotas. Schema operations are typically infrequent (setup time and occasional changes) so rate limits rarely bind in practice.
How do I create a custom object schema through Jentic?
Search Jentic for 'create hubspot custom object schema', load the POST /crm-object-schemas/v3/schemas operation, and execute it with name, labels, primaryDisplayProperty, requiredProperties, and a properties array. Jentic validates the input against the typed schema before sending.
Can I delete a custom object schema once it has records?
HubSpot only allows deleting a schema after all records of that object type have been archived. Use the Custom Objects API to archive existing records first, then call DELETE /crm-object-schemas/v3/schemas/{objectType}.
How do schema-level associations differ from record-level associations?
A schema-level association declares that two object types can be related (created via POST /crm-object-schemas/v3/schemas/{objectType}/associations). A record-level association uses the Associations API to link two specific records once the schema-level association exists. Both are required for end-to-end relationship modelling.
Can I limit what my agent is allowed to do with the HubSpot CRM Schemas API?
Yes. Because you self-host Jentic One, your own rules decide which of the seven Schemas operations your agent may call and which HubSpot credentials it may use. You can grant only read operations like GET /crm-object-schemas/v3/schemas and GET /crm-object-schemas/v3/schemas/{objectType} while withholding destructive ones such as DELETE on a schema or the removal of a schema association. Since the object type lives in the URL path, a rule can also pin the agent to a single object type for its reads and edits.
GET STARTED