Hubspot CLI
for cmdhub.
Hubspot resources through the cmdhub CLI.
cmdhub get hubspot
data_object Agent Contract
Agents should start with auth/status and discovery commands, inspect schemas before composition, and treat commands marked as mutating as state-changing operations.
Output
Use human output for normal reads, `--json` for scripting or complete structured fields, and `--jsonl` for upstream pipe inputs.
Auth
oauth
Refs
Prefer list/search, then short refs or piped JSONL. Use `resolve` to inspect cached refs.
Schemas
Use `hubspot schema` and `catalog.json` to inspect fields, flags, examples, and side effects.
terminal Command Reference
Generated from source. Global flags apply to all commands.
Global Flags
--json
bool
Emit JSON machine output--jsonl
bool
Emit JSONL records for piping--output, -o
string
Compatibility output mode: json|jsonl. Prefer --json or --jsonl--view
string = summary
View mode: summary|full--profile
string = default
Config/auth profile--config
string
Config path override--quiet, -q
bool
Suppress non-essential diagnostics--debug
bool
Enable debug diagnostics--limit
int = 50
Maximum items to emit--page-size
int = 50
Requested upstream page size--cursor
string
Continuation cursor--no-paginate
bool
Fetch only one page--version, -v
bool
Print version informationhubspot association
Manage exact HubSpot CRM associationsManage relationships between exact HubSpot CRM records.
Workflow: find both records, inspect association types when needed, add an exact relationship, or preview removal before confirming.
Selectors and filters: –from and –to use object:ref selectors such as contact:ct1 and company:co1. types uses –from –to .
Output: Human output uses local CRM refs. JSON and JSONL preserve exact HubSpot IDs and association type IDs.
Safety: association remove requires –dry-run or –yes. Records are not deleted when an association is removed.
hubspot association add
Associate two exact HubSpot CRM records--from
string
Source object type or object:ref, such as contact or contact:ct1--label
string
Association type ID from association types; omitted uses HubSpot default for the pair--to
string
Target object type or object:ref, such as company or company:co1hubspot association list
List HubSpot associations from an exact record--from
string
Source object type or object:ref, such as contact or contact:ct1--to
string
Target object type or object:ref, such as company or company:co1hubspot association remove
Remove an exact HubSpot CRM association--dry-run
bool
Preview the exact association removal without mutating HubSpot--from
string
Source object type or object:ref, such as contact or contact:ct1--to
string
Target object type or object:ref, such as company or company:co1--yes
bool
Confirm removal of the exact associationhubspot association types
List HubSpot association labels--from
string
Source object type or object:ref, such as contact or contact:ct1--to
string
Target object type or object:ref, such as company or company:co1hubspot auth
Manage HubSpot authenticationhubspot auth login
Authenticate with a HubSpot OAuth granthubspot auth logout
Remove stored HubSpot OAuth credentialshubspot auth refresh
Refresh the stored HubSpot OAuth access tokenhubspot auth status
Show HubSpot OAuth auth statushubspot auth whoami
Show the current HubSpot user and portalhubspot capabilities
Describe capabilities--section
string
Show one capability section: scopes, schemas, or commandshubspot cleanup
Plan, run, and verify bounded cleanup of disposable HubSpot CRM dataPlan, run, and verify bounded cleanup of disposable cmdhub HubSpot CRM data.
Workflow: create a cleanup manifest from a cmdhub-* token, review the manifest, run deletion with –yes, then verify the token is gone.
Selectors and filters: –token must start with cmdhub- or cmdhub-eval-. –objects bounds cleanup to contacts, companies, deals, tickets, and notes. –manifest selects the generated cleanup manifest for run and verify.
Output: Human output summarizes the manifest, refs, deleted records, and verification status. JSON preserves exact HubSpot IDs and URLs.
Safety: cleanup run requires –yes and only operates on records selected by a bounded manifest.
hubspot cleanup plan
Preview disposable cmdhub CRM records and write a cleanup manifest--manifest
string
Cleanup manifest path; defaults under apps/hubspot-cli/lifecycle/live--objects
string
Comma-separated object set: contacts, companies, deals, tickets, notes--token
string
Disposable cmdhub-* token to search forhubspot cleanup run
Delete only records listed in a cleanup manifest--dry-run
bool
Preview cleanup manifest deletion without deleting records--manifest
string
Cleanup manifest path from cleanup plan--yes
bool
Confirm deletion of only records listed in the manifesthubspot cleanup verify
Verify disposable cmdhub CRM records are gone--manifest
string
Cleanup manifest path to verify--objects
string
Comma-separated object set: contacts, companies, deals, tickets, notes--token
string
Disposable cmdhub-* token to search forhubspot company
Work with HubSpot company recordsWork with HubSpot company records.
Actions: list, search, get, create, update, upsert, delete, restore
Workflow: search or list records, inspect the selected local ref, then run exact create, update, move, delete, or restore commands.
Selectors and filters: get, update, delete, and restore accept local refs like co1, HubSpot record IDs, and exact unique values when available. Useful filters include –query, –owner, –created-after, –updated-after, –archived, and –property name=value. company records commonly use –domain as their unique selector.
Output: Human output uses local refs and hides long HubSpot IDs. Use –json or –jsonl for exact IDs, URLs, properties, cursors, and associations.
Safety: delete requires –dry-run or –yes. Use restore for records recoverable from the HubSpot recycle bin.
hubspot company create
Create a HubSpot company--city
string
Company city--country
string
Company country--domain
string
Company domain--industry
string
Company industry--lifecycle-stage
string
Company lifecycle stage--name
string
Company name--owner
string
HubSpot owner ID or ref--property
stringArray = []
Additional HubSpot property as name=valuehubspot company delete
Delete an exact HubSpot company--dry-run
bool
Preview the exact delete without mutating HubSpot--yes
bool
Confirm deletion of the exact displayed recordhubspot company get
Inspect a HubSpot companyhubspot company list
List HubSpot companies--archived
string
Archived filter: true or false--city
string
Filter by company city--country
string
Filter by company country--created-after
string
Only records created after YYYY-MM-DD or RFC3339--domain
string
Filter by company domain--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--industry
string
Filter by company industry--lifecycle-stage
string
Filter by company lifecycle stage--name
string
Filter by company name--owner
string
HubSpot owner ID, owner ref, email, or name--property
stringArray = []
Additional exact property filter as name=value--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot company restore
Restore a HubSpot company from recycle binhubspot company search
Search HubSpot companies--archived
string
Archived filter: true or false--city
string
Filter by company city--country
string
Filter by company country--created-after
string
Only records created after YYYY-MM-DD or RFC3339--domain
string
Filter by company domain--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--industry
string
Filter by company industry--lifecycle-stage
string
Filter by company lifecycle stage--name
string
Filter by company name--owner
string
HubSpot owner ID, owner ref, email, or name--property
stringArray = []
Additional exact property filter as name=value--query
string
Text to search across HubSpot default searchable properties--sort
stringArray = []
Sort as property:asc or property:desc--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot company update
Update an exact HubSpot company--city
string
Company city--country
string
Company country--domain
string
Company domain--industry
string
Company industry--lifecycle-stage
string
Company lifecycle stage--name
string
Company name--owner
string
HubSpot owner ID or ref--property
stringArray = []
HubSpot property update as name=valuehubspot company upsert
Create or update a HubSpot company by domain--city
string
Company city--country
string
Company country--domain
string
Company domain--industry
string
Company industry--lifecycle-stage
string
Company lifecycle stage--name
string
Company name--owner
string
HubSpot owner ID or ref--property
stringArray = []
Additional HubSpot property as name=valuehubspot config
Inspect local configurationhubspot config explain
Explain resolved configurationhubspot contact
Work with HubSpot contact recordsWork with HubSpot contact records.
Actions: list, search, get, create, update, upsert, delete, restore
Workflow: search or list records, inspect the selected local ref, then run exact create, update, move, delete, or restore commands.
Selectors and filters: get, update, delete, and restore accept local refs like ct1, HubSpot record IDs, and exact unique values when available. Useful filters include –query, –owner, –created-after, –updated-after, –archived, and –property name=value. contact records commonly use –email as their unique selector.
Output: Human output uses local refs and hides long HubSpot IDs. Use –json or –jsonl for exact IDs, URLs, properties, cursors, and associations.
Safety: delete requires –dry-run or –yes. Use restore for records recoverable from the HubSpot recycle bin.
hubspot contact create
Create a HubSpot contact--email
string
Contact email--first-name
string
Contact first name--last-name
string
Contact last name--lifecycle-stage
string
Contact lifecycle stage--owner
string
HubSpot owner ID or ref--phone
string
Contact phone number--property
stringArray = []
Additional HubSpot property as name=valuehubspot contact delete
Delete an exact HubSpot contact--dry-run
bool
Preview the exact delete without mutating HubSpot--yes
bool
Confirm deletion of the exact displayed recordhubspot contact get
Inspect a HubSpot contacthubspot contact list
List HubSpot contacts--archived
string
Archived filter: true or false--created-after
string
Only records created after YYYY-MM-DD or RFC3339--email
string
Filter by contact email--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--first-name
string
Filter by contact first name--last-name
string
Filter by contact last name--lifecycle-stage
string
Filter by contact lifecycle stage--owner
string
HubSpot owner ID, owner ref, email, or name--phone
string
Filter by contact phone--property
stringArray = []
Additional exact property filter as name=value--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot contact restore
Restore a HubSpot contact from recycle binhubspot contact search
Search HubSpot contacts--archived
string
Archived filter: true or false--created-after
string
Only records created after YYYY-MM-DD or RFC3339--email
string
Filter by contact email--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--first-name
string
Filter by contact first name--last-name
string
Filter by contact last name--lifecycle-stage
string
Filter by contact lifecycle stage--owner
string
HubSpot owner ID, owner ref, email, or name--phone
string
Filter by contact phone--property
stringArray = []
Additional exact property filter as name=value--query
string
Text to search across HubSpot default searchable properties--sort
stringArray = []
Sort as property:asc or property:desc--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot contact update
Update an exact HubSpot contact--email
string
Contact email--first-name
string
Contact first name--last-name
string
Contact last name--lifecycle-stage
string
Contact lifecycle stage--owner
string
HubSpot owner ID or ref--phone
string
Contact phone number--property
stringArray = []
HubSpot property update as name=valuehubspot contact upsert
Create or update a HubSpot contact by email--email
string
Contact email--first-name
string
Contact first name--last-name
string
Contact last name--lifecycle-stage
string
Contact lifecycle stage--owner
string
HubSpot owner ID or ref--phone
string
Contact phone number--property
stringArray = []
Additional HubSpot property as name=valuehubspot deal
Work with HubSpot deal recordsWork with HubSpot deal records.
Actions: list, search, get, create, update, move, delete, restore
Workflow: search or list records, inspect the selected local ref, then run exact create, update, move, delete, or restore commands.
Selectors and filters: get, update, delete, and restore accept local refs like d1, HubSpot record IDs, and exact unique values when available. Useful filters include –query, –owner, –created-after, –updated-after, –archived, and –property name=value. deal records commonly use –name as their unique selector.
Output: Human output uses local refs and hides long HubSpot IDs. Use –json or –jsonl for exact IDs, URLs, properties, cursors, and associations.
Safety: delete requires –dry-run or –yes. Use restore for records recoverable from the HubSpot recycle bin.
hubspot deal create
Create a HubSpot deal--amount
string
Deal amount--close-date
string
Deal close date--company
string
Company ref or ID to associate after create--contact
string
Contact ref or ID to associate after create--description
string
Deal description--name
string
Deal name--owner
string
HubSpot owner ID or ref--pipeline
string
Deal pipeline ID or ref--property
stringArray = []
Additional HubSpot property as name=value--stage
string
Deal stage ID or refhubspot deal delete
Delete an exact HubSpot deal--dry-run
bool
Preview the exact delete without mutating HubSpot--yes
bool
Confirm deletion of the exact displayed recordhubspot deal get
Inspect a HubSpot dealhubspot deal list
List HubSpot deals--amount
string
Filter by deal amount--archived
string
Archived filter: true or false--close-date
string
Filter by deal close date--company
string
Filter by associated company ref or ID--contact
string
Filter by associated contact ref or ID--created-after
string
Only records created after YYYY-MM-DD or RFC3339--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--name
string
Filter by deal name--owner
string
HubSpot owner ID, owner ref, email, or name--pipeline
string
Filter by deal pipeline ID or ref--property
stringArray = []
Additional exact property filter as name=value--stage
string
Filter by deal stage ID, ref, or label--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot deal move
Move a HubSpot deal to another stagehubspot pipeline get p1 --object deal, an exact stage ID, or an unambiguous stage label. Use –pipeline when labels are ambiguous across pipelines.--pipeline
string
Pipeline ref or pipeline ID--stage
string
Stage ref, stage ID, or stage labelhubspot deal restore
Restore a HubSpot deal from recycle binhubspot deal search
Search HubSpot deals--amount
string
Filter by deal amount--archived
string
Archived filter: true or false--close-date
string
Filter by deal close date--company
string
Filter by associated company ref or ID--contact
string
Filter by associated contact ref or ID--created-after
string
Only records created after YYYY-MM-DD or RFC3339--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--name
string
Filter by deal name--owner
string
HubSpot owner ID, owner ref, email, or name--pipeline
string
Filter by deal pipeline ID or ref--property
stringArray = []
Additional exact property filter as name=value--query
string
Text to search across HubSpot default searchable properties--sort
stringArray = []
Sort as property:asc or property:desc--stage
string
Filter by deal stage ID, ref, or label--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot deal update
Update an exact HubSpot deal--amount
string
Deal amount--close-date
string
Deal close date--company
string
Company ref or ID to associate after create--contact
string
Contact ref or ID to associate after create--description
string
Deal description--name
string
Deal name--owner
string
HubSpot owner ID or ref--pipeline
string
Deal pipeline ID or ref--property
stringArray = []
HubSpot property update as name=value--stage
string
Deal stage ID or refhubspot doctor
Run diagnosticsRun HubSpot diagnostics for the active profile.
Checks include the local credential backend, selected profile, OAuth broker setup, stored HubSpot OAuth token readiness, required scopes, and HubSpot API reachability. Use this before retrying auth, CRM, metadata, or cleanup workflows that fail with auth or upstream-provider errors.
hubspot mcp
Run the MCP serverRun a stdio Model Context Protocol server for this adapter.
The server exposes read-only resource commands by default. Mutating commands are listed only when explicitly allowed with –allow and remain gated by the command contract safety class.
--allow
stringArray = []
Allow mutating command keys such as gmail.message.archive or gmail.message.label.*--allow-dangerous
bool
Allow --allow wildcards to include destructive or sends_external commands--concurrency
int
Maximum concurrent MCP subprocesses--max-output
int64 = 0
Maximum stdout/stderr bytes captured per MCP command--print-config
bool
Print MCP tool configuration and exit--timeout
duration = 0s
Per-command MCP subprocess timeout, for example 45s or 2mhubspot note
Work with HubSpot CRM notesWork with HubSpot notes attached to exact CRM records.
Workflow: find the target contact, company, deal, or ticket; create or list notes with –on object:ref; then inspect or update the note by local ref.
Selectors and filters: –on accepts contact:ct1, company:co1, deal:d1, or ticket:tk1. create accepts –body or –body-file. list and search accept created/updated filters and pagination flags.
Output: Human output uses note refs n1 and CRM refs. JSON and JSONL preserve exact note IDs and associations.
Safety: delete requires –dry-run or –yes. Pin and unpin require an exact target record.
hubspot note create
Create a HubSpot CRM note--body
string
Note body--body-file
string
Read note body from a local UTF-8 file--company
string
Company ref or ID to associate--contact
string
Contact ref or ID to associate--deal
string
Deal ref or ID to associate--on
string
Target record as object:ref, such as deal:d1--ticket
string
Ticket ref or ID to associatehubspot note delete
Delete an exact HubSpot CRM note--dry-run
bool
Preview the exact note deletion without mutating HubSpot--yes
bool
Confirm deletion of the exact displayed notehubspot note get
Inspect a HubSpot CRM notehubspot note list
List HubSpot CRM notes--created-after
string
Only records created after YYYY-MM-DD or RFC3339--on
string
Target record as object:ref, such as deal:d1hubspot note pin
Pin a HubSpot CRM note on a record--on
string
Target record as object:ref, such as deal:d1hubspot note search
Search HubSpot CRM notes--created-after
string
Only records created after YYYY-MM-DD or RFC3339--on
string
Target record as object:ref, such as deal:d1--query
string
Text to search note bodies--sort
stringArray = []
Sort as property:asc or property:deschubspot note unpin
Unpin a HubSpot CRM note from a record--on
string
Target record as object:ref, such as deal:d1hubspot note update
Update an exact HubSpot CRM note--body
string
Updated note body--property
stringArray = []
HubSpot note property update as name=valuehubspot owner
Discover HubSpot ownersDiscover assignable HubSpot CRM owners before create or update commands.
Workflow: list or search owners, then use displayed owner refs such as o1 with –owner on CRM record commands.
Selectors and filters: owner get accepts an owner ref, owner ID, email, or exact name. owner search accepts –query for names and email addresses.
Output: Human output uses owner refs o1. JSON and JSONL preserve exact HubSpot owner IDs.
Safety: Read-only metadata. The HubSpot owner ID is the assignment value, not userId.
hubspot owner get
Inspect a HubSpot ownerhubspot owner list
List HubSpot ownershubspot owner search
Search HubSpot owners--query
string
Text to match owner name or emailhubspot pipeline
Discover HubSpot deal and ticket pipelinesDiscover read-only HubSpot deal and ticket pipeline metadata before moving records.
Workflow: list pipelines for the object, inspect one pipeline, then use displayed stage refs with deal move or ticket move.
Selectors and filters: pipeline get accepts a local pipeline ref such as p1, a HubSpot pipeline ID, or an exact pipeline label. –object selects deal or ticket pipelines.
Output: Human output uses pipeline refs p1 and stage refs s1. JSON and JSONL preserve exact HubSpot IDs.
Safety: Pipeline and stage administration is out of scope; this command only reads metadata.
hubspot pipeline get
Inspect a HubSpot pipeline and cache stages--object
string = deal
Pipeline object: deal or tickethubspot pipeline list
List HubSpot pipelines--object
string = deal
Pipeline object: deal or tickethubspot pipeline stage
Discover HubSpot pipeline stagesDiscover valid stage refs for deal and ticket move commands.
Workflow: inspect a pipeline with hubspot pipeline get p1, then use the stage refs with deal move or ticket move.
Selectors and filters: stage get accepts a stage ref such as s1, a HubSpot stage ID, or an exact stage label. –pipeline accepts a pipeline ref, ID, or label. –object selects deal or ticket.
Output: Human output uses stage refs s1. JSON and JSONL preserve exact HubSpot IDs.
hubspot pipeline stage get
Inspect a HubSpot pipeline stage--object
string = deal
Pipeline object: deal or ticket--pipeline
string
Pipeline ref, ID, or labelhubspot pipeline stage list
List HubSpot pipeline stages--object
string = deal
Pipeline object: deal or ticket--pipeline
string
Pipeline ref, ID, or labelhubspot profile
Manage provider profileshubspot profile create
Create an unauthenticated provider profilehubspot profile delete
Delete a local provider profilehubspot profile list
List provider profileshubspot profile rename
Rename a local provider profilehubspot profile use
Set the default provider profilehubspot property
Discover HubSpot CRM propertiesDiscover valid HubSpot property internal names, field types, and option values.
Workflow: search properties for an object, inspect a property, then use –property name=value on create, update, list, or search commands.
Selectors and filters: property get accepts a property ref such as pr1, an internal property name, or an exact label. –object selects contact, company, deal, ticket, or note.
Output: Human output uses property refs pr1 and internal names. JSON and JSONL preserve full property metadata.
Safety: Read-only metadata. Read-only properties are shown so agents avoid invalid update attempts.
hubspot property get
Inspect a HubSpot property--object
string = contact
CRM object: contact, company, deal, or tickethubspot property list
List HubSpot properties--object
string = contact
CRM object: contact, company, deal, or tickethubspot property search
Search HubSpot properties--object
string = contact
CRM object: contact, company, deal, or ticket--query
string
Text to match against property label, name, or descriptionhubspot resolve
Resolve a local ref, short id, or URL aliashubspot schema
Emit schema hints--in
bool
Show input schema--input
bool
Show input schema--out
bool
Show output schemahubspot ticket
Work with HubSpot ticket recordsWork with HubSpot ticket records.
Actions: list, search, get, create, update, move, delete, restore
Workflow: search or list records, inspect the selected local ref, then run exact create, update, move, delete, or restore commands.
Selectors and filters: get, update, delete, and restore accept local refs like tk1, HubSpot record IDs, and exact unique values when available. Useful filters include –query, –owner, –created-after, –updated-after, –archived, and –property name=value. ticket records commonly use –subject as their unique selector.
Output: Human output uses local refs and hides long HubSpot IDs. Use –json or –jsonl for exact IDs, URLs, properties, cursors, and associations.
Safety: delete requires –dry-run or –yes. Use restore for records recoverable from the HubSpot recycle bin.
hubspot ticket create
Create a HubSpot ticket--company
string
Company ref or ID to associate after create--contact
string
Contact ref or ID to associate after create--content
string
Ticket content--owner
string
HubSpot owner ID or ref--pipeline
string
Ticket pipeline ID or ref--priority
string
Ticket priority--property
stringArray = []
Additional HubSpot property as name=value--stage
string
Ticket stage ID or ref--subject
string
Ticket subjecthubspot ticket delete
Delete an exact HubSpot ticket--dry-run
bool
Preview the exact delete without mutating HubSpot--yes
bool
Confirm deletion of the exact displayed recordhubspot ticket get
Inspect a HubSpot tickethubspot ticket list
List HubSpot tickets--archived
string
Archived filter: true or false--company
string
Filter by associated company ref or ID--contact
string
Filter by associated contact ref or ID--created-after
string
Only records created after YYYY-MM-DD or RFC3339--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--owner
string
HubSpot owner ID, owner ref, email, or name--pipeline
string
Filter by ticket pipeline ID or ref--priority
string
Filter by ticket priority--property
stringArray = []
Additional exact property filter as name=value--stage
string
Filter by ticket stage ID, ref, or label--subject
string
Filter by ticket subject--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot ticket move
Move a HubSpot ticket to another stagehubspot pipeline get p1 --object ticket, an exact stage ID, or an unambiguous stage label. Use –pipeline when labels are ambiguous across pipelines.--pipeline
string
Pipeline ref or pipeline ID--stage
string
Stage ref, stage ID, or stage labelhubspot ticket restore
Restore a HubSpot ticket from recycle binhubspot ticket search
Search HubSpot tickets--archived
string
Archived filter: true or false--company
string
Filter by associated company ref or ID--contact
string
Filter by associated contact ref or ID--created-after
string
Only records created after YYYY-MM-DD or RFC3339--filter
stringArray = []
Property filter as name=value, name:OP:value, or "name OP value"--owner
string
HubSpot owner ID, owner ref, email, or name--pipeline
string
Filter by ticket pipeline ID or ref--priority
string
Filter by ticket priority--property
stringArray = []
Additional exact property filter as name=value--query
string
Text to search across HubSpot default searchable properties--sort
stringArray = []
Sort as property:asc or property:desc--stage
string
Filter by ticket stage ID, ref, or label--subject
string
Filter by ticket subject--updated-after
string
Only records updated after YYYY-MM-DD or RFC3339hubspot ticket update
Update an exact HubSpot ticket--company
string
Company ref or ID to associate after create--contact
string
Contact ref or ID to associate after create--content
string
Ticket content--owner
string
HubSpot owner ID or ref--pipeline
string
Ticket pipeline ID or ref--priority
string
Ticket priority--property
stringArray = []
HubSpot property update as name=value--stage
string
Ticket stage ID or ref--subject
string
Ticket subjecthubspot version
Show version informationplay_circle Live Examples
Output captured from a real workspace. Regenerate with
scripts/gen-docs.sh --update.
auth
HubSpot auth ready
Field Value
------------------ -----
Profile kestrelphilip@gmail.com
Auth mode oauth
User email kestrelphilip@gmail.com
User ID {id}
Hub ID {id}
Portal HubSpot portal {id}
Scopes crm.objects.companies.read, crm.objects.companies.write, crm.objects.contacts.read, crm.objects.contacts.write, crm.objects.deals.read, crm.objects.deals.write, crm.objects.owners.read, oauth, tickets
Missing scopes none
API base https://api.hubapi.com
Provider ready yes
Token valid yes
Expires 2026-07-06T09:21:04Z
Credential backend file
Next steps:
- Current identity: hubspot auth whoami
- Diagnostics: hubspot doctor
- Search contacts: hubspot contact search --query "<text>"HubSpot identity
Field Value
-------------- -----
Profile kestrelphilip@gmail.com
Auth mode oauth
User email kestrelphilip@gmail.com
User ID {id}
Hub ID {id}
Portal HubSpot portal {id}
Scopes crm.objects.companies.read, crm.objects.companies.write, crm.objects.contacts.read, crm.objects.contacts.write, crm.objects.deals.read, crm.objects.deals.write, crm.objects.owners.read, oauth, tickets
Missing scopes none
API base https://api.hubapi.com
Next steps:
- Status: hubspot auth status
- Diagnostics: hubspot doctor
- Search contacts: hubspot contact search --query "<text>"hubspot doctor: WARN Account: kestrelphilip@gmail.com Checks: credential_backend ok, credential_security warn, profiles ok, credential_backend warn, oauth_setup ok, auth ok, connectivity ok, scope ok CHECK STATUS DETAIL credential_backend OK using file credential_security WARN credential backend stores local plaintext secrets profiles OK active profile "kestrelphilip@gmail.com" credential_backend WARN file oauth_setup OK HubSpot OAuth broker configured auth OK HubSpot OAuth token ready connectivity OK HubSpot OAuth token introspection reachable scope OK required HubSpot OAuth scopes granted Next steps: - Status: hubspot auth whoami - Capabilities: hubspot capabilities
alt_route Composition Patterns
Bridge your ecosystem with zero middleware.
# Inspect auth state and available command schemas
hubspot auth status --json
hubspot schema