| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.hubapi.com/ | link | — | — | — |
Actions (70)
CRM · 53
- Archive contactsPOST /crm/v3/objects/contacts/batch/archive
Archive multiple contacts.
documented - Archive recordsPOST /crm/v3/objects/{objectTypeId}/batch/archive
Archive (delete to recycling bin) multiple records in batch.
documented - Associate companyPUT /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
Associate a company with another object.
documented - Associate contactPUT /crm/v3/contacts/{contactId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
Create a relationship between a contact and another object.
documented - Batch read companiesPOST /crm/v3/objects/companies/batch/read
Read multiple companies in batch.
documented - Batch read contactsPOST /crm/v3/objects/contacts/batch/read
Read multiple contacts in batch.
documented - Batch read recordsPOST /crm/v3/objects/{objectTypeId}/batch/read
Read multiple records by IDs or idProperty in batch.
documented - Batch update companiesPOST /crm/v3/objects/companies/batch/update
Update multiple companies in batch.
documented - Batch update contactsPOST /crm/v3/objects/contacts/batch/update
Update multiple contacts in batch.
documented - Batch update recordsPOST /crm/v3/objects/{objectTypeId}/batch/update
Update multiple records in batch.
documented - Batch upsert contactsPOST /crm/v3/objects/contacts/batch/upsert
Upsert (insert or update) multiple contacts.
documented - Batch upsert recordsPOST /crm/v3/objects/{objectTypeId}/batch/upsert
Upsert (insert or update) multiple records in batch.
documented - Create associationsPOST /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create
Create associations in batch between two object types.
documented - Create associationsPUT /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create
Create associations in batch between two object types.
documented - Create companyPOST /crm/v3/objects/companies
Create a company record.
documented - Create company propertyPOST /crm/v3/properties/companies
Create a new company property.
documented - Create contactPOST /crm/v3/objects/contacts
Create a single contact record.
documented - Create contact propertyPOST /crm/v3/properties/contacts
Create a new contact property.
documented - Create multiple contactsPOST /crm/v3/objects/contacts/batch/create
Create multiple contacts in a single request.
documented - Create multiple recordsPOST /crm/v3/objects/{objectTypeId}/batch/create
Create multiple CRM object records in a single request.
documented - Create propertyPOST /crm/v3/properties/{objectTypeId}
Create a new property definition for an object type.
documented - Create recordPOST /crm/v3/objects/{objectTypeId}
Create a new CRM object record for the specified object type (e.g., contacts, companies, deals).
documented - Delete companyDELETE /crm/v3/objects/companies/{companyId}
Delete a company.
documented - Delete contactDELETE /crm/v3/objects/contacts/{contactId}
Delete a contact.
documented - Delete recordDELETE /crm/v3/objects/{objectTypeId}/{recordId}
Delete a single record by ID.
documented - Get company by IDGET /crm/v3/objects/companies/{companyId}
Retrieve a company by ID.
documented - Get contact by IDGET /crm/v3/objects/contacts/{contactId}
Get a contact by its internal ID.
documented - Get contact by emailGET /crm/v3/objects/contacts/{email}?idProperty=email
Get a contact by email using idProperty parameter.
documented - Get contact propertyGET /crm/v3/properties/contacts/{propertyName}
Retrieve a contact property.
documented - Get object library enablementGET /crm/v3/object-library/enablement
Retrieve enablement status for objects in the library.
documented - Get ownerGET /crm/v3/owners/{ownerId}
Retrieve details for a specific owner by ID.
documented - Get propertyGET /crm/v3/properties/{objectTypeId}/{propertyName}
Retrieve a specific property definition.
documented - Get recordGET /crm/v3/objects/{objectTypeId}/{recordId}
Retrieve a specific record by its ID.
documented - List association typesGET /crm/v3/associations/{fromObjectType}/{toObjectType}/types
Return available association types between two object types.
documented - List companiesGET /crm/v3/objects/companies
List companies.
documented - List company propertiesGET /crm/v3/properties/companies
Retrieve all company properties.
documented - List contact propertiesGET /crm/v3/properties/contacts
Retrieve all contact properties.
documented - List contactsGET /crm/v3/objects/contacts
List contacts.
documented - List custom object schemasGET /crm/v3/schemas
List schema definitions for custom objects.
documented - List object propertiesGET /crm/v3/properties/{objectTypeId}
List all properties for an object type.
documented - List ownersGET /crm/v3/owners
Retrieve the current owners for the connected HubSpot account.
documented - List recordsGET /crm/v3/objects/{objectTypeId}
Retrieve a list of records for the given object type.
documented - Read associations in batchPOST /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read
Read associations in batch for given source objects.
documented - Read associations in batchPOST /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read
Read associations in batch between object types.
documented - Remove associations in batchPOST /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive
Remove batch associations between objects.
documented - Remove associations in batchPOST /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive
Remove batch associations between object records.
documented - Remove company associationDELETE /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
Remove a specific association for a company.
documented - Remove contact associationDELETE /crm/v3/objects/contacts/{contactId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
Remove a specific association for a contact.
documented - Update companyPATCH /crm/v3/objects/companies/{companyId}
Update a company by ID.
documented - Update contactPATCH /crm/v3/objects/contacts/{contactId}
Update a single contact.
documented - Update contact propertyPATCH /crm/v3/properties/contacts/{propertyName}
Update a contact property.
documented - Update propertyPATCH /crm/v3/properties/{objectTypeId}/{propertyName}
Update a property definition.
documented - Update recordPATCH /crm/v3/objects/{objectTypeId}/{recordId}
Update a single record by ID.
documented
CMS · 11
- Get blog postGET /cms/v3/blogs/posts/{objectId}
Retrieve a blog post by ID.
documented - Get blog settingGET /cms/v3/blog-settings/settings/{blogId}
Get a blog setting by ID.
documented - List HubDB tablesGET /cms/v3/hubdb/tables
List HubDB tables.
documented - List blog authorsGET /cms/v3/blogs/authors
List blog authors for blogs.
documented - List blog postsGET /cms/v3/blogs/posts
Retrieve blog posts.
documented - List blog settingsGET /cms/v3/blog-settings/settings
List blog settings/settings.
documented - List blog tagsGET /cms/v3/blogs/tags
List blog tags.
documented - List site pagesGET /cms/v3/pages/site-pages
List site pages.
documented - Publish blog postPATCH /cms/v3/blogs/posts/{objectId}
Publish a blog post by setting state to PUBLISHED.
documented - Schedule blog post publishPOST /cms/v3/blogs/posts/schedule
Schedule publishing of a blog post.
documented - Site searchGET /cms/v3/site-search/search
Search across HubSpot-hosted sites.
documented
Marketing · 6
- Create marketing emailPOST /marketing/v3/emails
Create a new marketing email.
documented - Create marketing formPOST /marketing/v3/forms
Create a new marketing form.
documented - Get marketing emailGET /marketing/v3/emails/{emailId}
Retrieve a marketing email by ID.
documented - List marketing emailsGET /marketing/v3/emails
List marketing emails.
documented - List marketing formsGET /marketing/v3/forms
List forms.
documented - Paginate marketing emailsGET /marketing/v3/emails/emails?after={cursor}
Paginate through marketing emails.
documented