HubSpot

Manage your HubSpot account.

Authentication

This connector uses OAuth 2.0 authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 985 actions:

Action	Purpose	Parameters
account_info/get_account_info_v3_activity_login	Get login activity.	after (string) limit (integer) userId (integer)
account_info/get_account_info_v3_activity_audit_logs	No description available	after (string) limit (integer) actingUserId (array) occurredAfter (string) occurredBefore (string) sort (array)
account_info/get_account_info_v3_api_usage_daily	Get daily API usage	No parameters
account_info/get_account_info_v3_details	Get account details	No parameters
account_info/get_account_info_v3_activity_security	Get security activity	after (string) limit (integer) userId (integer) fromTimestamp (integer)
actions_v4/post_automation_v4_actions_callbacks_by_callback_id_complete	Complete a specific blocked action execution by ID.	callbackId (string) data: { . outputFields (object) } (object) required
actions_v4/post_automation_v4_actions_callbacks_complete	Complete a batch of blocked action executions.	data: { . inputs (array) } (object) required
actions_v4/get_automation_v4_actions_by_app_id	Retrieve custom workflow action definitions by app ID.	appId (integer) limit (integer) after (string) archived (boolean)
actions_v4/post_automation_v4_actions_by_app_id	Create a new custom workflow action.	appId (integer) data: { . inputFields (array) . outputFields (array) . archivedAt (integer) . functions (array) . actionUrl (string) . inputFieldDependencies (array) . published (boolean) . executionRules (array) . objectTypes (array) . objectRequestOptions . labels (object) } (object) required
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_functions	Retrieve all functions included in a definition.	definitionId (string) appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type	Get all functions by a type for a given definition	definitionId (string) functionType (string) appId (integer)
actions_v4/put_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type	Add a function for a given definition.	definitionId (string) functionType (string) appId (integer)
actions_v4/delete_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type	Delete a function within a given definition.	definitionId (string) functionType (string) appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_revisions_by_revision_id	Retrieve a specific revision of a definition by revision ID.	definitionId (string) revisionId (string) appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id	Retrieve a custom workflow action definition by ID.	definitionId (string) appId (integer) archived (boolean)
actions_v4/delete_automation_v4_actions_by_app_id_by_definition_id	Delete an action definition by ID.	definitionId (string) appId (integer)
actions_v4/patch_automation_v4_actions_by_app_id_by_definition_id	Update an existing action definition by ID.	definitionId (string) appId (integer) data: { . inputFields (array) . outputFields (array) . actionUrl (string) . inputFieldDependencies (array) . published (boolean) . executionRules (array) . objectTypes (array) . objectRequestOptions . labels (object) } (object) required
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type_by_function_id	Retrieve a specific function from a given definition.	definitionId (string) functionType (string) functionId (string) appId (integer)
actions_v4/put_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type_by_function_id	Update a function for a given definition by ID.	definitionId (string) functionType (string) functionId (string) appId (integer)
actions_v4/delete_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type_by_function_id	Archive a function for a definition	definitionId (string) functionType (string) functionId (string) appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_revisions	Retrieve the versions of a definition by ID.	definitionId (string) appId (integer) limit (integer) after (string)
appointments/post_crm_v3_objects_by_object_type_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	objectType (string) archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
appointments/get_crm_v3_objects_by_object_type_by_object_id	Read an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	objectType (string) objectId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
appointments/delete_crm_v3_objects_by_object_type_by_object_id	Move an Object identified by objectId to the recycling bin.	objectType (string) objectId (string)
appointments/patch_crm_v3_objects_by_object_type_by_object_id	Perform a partial update of an Object identified by objectIdor optionally a unique property value as specified by the idProperty query param. objectId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	objectType (string) objectId (string) idProperty (string) data: { . properties (object) } (object) required
appointments/post_crm_v3_objects_by_object_type_batch_archive	Archive a batch of objects by ID	objectType (string) data: { . inputs (array) } (object) required
appointments/post_crm_v3_objects_by_object_type_batch_create	Create a batch of objects	objectType (string) data: { . inputs (array) } (object) required
appointments/post_crm_v3_objects_by_object_type_batch_update	Update a batch of objects by internal ID, or unique property values	objectType (string) data: { . inputs (array) } (object) required
appointments/get_crm_v3_objects_by_object_type	Read a page of objects. Control what is returned via the properties query param.	objectType (string) limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
appointments/post_crm_v3_objects_by_object_type	Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.	objectType (string) data: { . associations (array) . properties (object) } (object) required
appointments/post_crm_v3_objects_by_object_type_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	objectType (string) data: { . inputs (array) } (object) required
appointments/post_crm_v3_objects_by_object_type_search	No description available	objectType (string) data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
app_uninstalls/delete_appinstalls_v3_external_install	Use this endpoint to uninstall your app from a customer's HubSpot account. If successful, this endpoint will return a 204 and the customer will receive an email notification that the developer has uninstall the app from their account.	No parameters
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_archive	Batch delete associations for objects	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_create	Batch create associations for objects	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
associations/post_crm_v4_associations_usage_high_usage_report_by_user_id	Requests a report of all objects in the portal which have a high usage of associations	userId (integer)
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_labels_archive	Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_read	Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_associate_default	Create the default most generic association type between two object types	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
associations/put_crm_v4_objects_by_object_type_by_object_id_associations_by_to_object_type_by_to_object_id	Set association labels between two records.	objectType (string) objectId (string) toObjectType (string) toObjectId (string) data (array) required
associations/delete_crm_v4_objects_by_object_type_by_object_id_associations_by_to_object_type_by_to_object_id	deletes all associations between two records.	objectType (string) objectId (string) toObjectType (string) toObjectId (string)
associations/get_crm_v4_objects_by_object_type_by_object_id_associations_by_to_object_type	List all associations of an object by object type. Limit 500 per call.	objectType (string) objectId (string) toObjectType (string) after (string) limit (integer)
associations/put_crm_v4_objects_by_from_object_type_by_from_object_id_associations_default_by_to_object_type_by_to_object_id	Create the default most generic association type between two object types	fromObjectType (string) fromObjectId (string) toObjectType (string) toObjectId (string)
associations_schema/get_crm_v4_associations_definitions_configurations_all	Returns all user configurations available on a given portal	No parameters
associations_schema/get_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_type	Returns user configurations on all association definitions between two object types	fromObjectType (string) toObjectType (string)
associations_schema/post_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_type_batch_create	Batch create user configurations between two object types	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
associations_schema/get_crm_v4_associations_by_from_object_type_by_to_object_type_labels	Returns all association types between two object types	fromObjectType (string) toObjectType (string)
associations_schema/put_crm_v4_associations_by_from_object_type_by_to_object_type_labels	Update a user defined association definition	fromObjectType (string) toObjectType (string) data: { . inverseLabel (string) . associationTypeId (integer) . label (string) } (object) required
associations_schema/post_crm_v4_associations_by_from_object_type_by_to_object_type_labels	Create a user defined association definition	fromObjectType (string) toObjectType (string) data: { . inverseLabel (string) . name (string) . label (string) } (object) required
associations_schema/post_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_type_batch_purge	Batch delete user configurations between two object types	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
associations_schema/delete_crm_v4_associations_by_from_object_type_by_to_object_type_labels_by_association_type_id	Deletes an association definition	fromObjectType (string) toObjectType (string) associationTypeId (integer)
associations_schema/post_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_type_batch_update	Batch update user configurations between two object types	fromObjectType (string) toObjectType (string) data: { . inputs (array) } (object) required
audit_logs/get_account_info_v3_activity_login	Get login activity.	after (string) limit (integer) userId (integer)
audit_logs/get_account_info_v3_activity_audit_logs	No description available	after (string) limit (integer) actingUserId (array) occurredAfter (string) occurredBefore (string) sort (array)
audit_logs/get_account_info_v3_api_usage_daily	Get daily API usage	No parameters
audit_logs/get_account_info_v3_details	Get account details	No parameters
audit_logs/get_account_info_v3_activity_security	Get security activity	after (string) limit (integer) userId (integer) fromTimestamp (integer)
authors/get_cms_v3_blogs_authors_by_object_id	Retrieve the Blog Author object identified by the id in the path.	objectId (string) archived (boolean) property (string)
authors/delete_cms_v3_blogs_authors_by_object_id	Delete the Blog Author object identified by the id in the path.	objectId (string) archived (boolean)
authors/patch_cms_v3_blogs_authors_by_object_id	Sparse updates a single Blog Author object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified.	objectId (string) archived (boolean) data: { . website (string) . displayName (string) . created (string) . facebook (string) . fullName (string) . bio (string) . language (string) . linkedin (string) . avatar (string) . translatedFromId (integer) . twitter (string) . deletedAt (string) . name (string) . id (string) . updated (string) . email (string) . slug (string) } (object) required
authors/post_cms_v3_blogs_authors_batch_update	Update the Blog Author objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
authors/post_cms_v3_blogs_authors_multi_language_detach_from_lang_group	Detach a Blog Author from a multi-language group.	data: { . id (string) } (object) required
authors/put_cms_v3_blogs_authors_multi_language_set_new_lang_primary	Set a Blog Author as the primary language of a multi-language group.	data: { . id (string) } (object) required
authors/post_cms_v3_blogs_authors_batch_archive	Delete the Blog Author objects identified in the request body.	data: { . inputs (array) } (object) required
authors/post_cms_v3_blogs_authors_batch_create	Create the Blog Author objects detailed in the request body.	data: { . inputs (array) } (object) required
authors/post_cms_v3_blogs_authors_batch_read	Retrieve the Blog Author objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
authors/get_cms_v3_blogs_authors	Get the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean) property (string)
authors/post_cms_v3_blogs_authors	Create a new Blog Author.	data: { . website (string) . displayName (string) . created (string) . facebook (string) . fullName (string) . bio (string) . language (string) . linkedin (string) . avatar (string) . translatedFromId (integer) . twitter (string) . deletedAt (string) . name (string) . id (string) . updated (string) . email (string) . slug (string) } (object) required
authors/post_cms_v3_blogs_authors_multi_language_attach_to_lang_group	Attach a Blog Author to a multi-language group.	data: { . language (string) . id (string) . primaryId (string) . primaryLanguage (string) } (object) required
authors/post_cms_v3_blogs_authors_multi_language_create_language_variation	Create a new language variation from an existing Blog Author.	data: { . language (string) . id (string) . primaryLanguage (string) . blogAuthor } (object) required
authors/post_cms_v3_blogs_authors_multi_language_update_languages	Explicitly set new languages for each Blog Author in a multi-language group.	data: { . languages (object) . primaryId (string) } (object) required
automation_v4/post_automation_v4_flows_batch_read	Retrieve a batch of workflows by ID.	data: { . inputs (array) } (object) required
automation_v4/get_automation_v4_flows_email_campaigns	Retrieve emails sent by a workflow by ID.	after (string) before (string) limit (integer) flowId (array)
automation_v4/post_automation_v4_workflow_id_mappings_batch_read	Retrieve the IDs of v3 workflows that have been migrated to the v4 API.	data: { . inputs (array) } (object) required
automation_v4/get_automation_v4_flows	Retrieve all workflows from an account.	after (string) limit (integer)
automation_v4/post_automation_v4_flows	Create a new workflow.	data (undefined) required
automation_v4/get_automation_v4_flows_by_flow_id	Retrieve all details for a specific workflow by ID.	flowId (string)
automation_v4/put_automation_v4_flows_by_flow_id	Update a workflow by ID.	flowId (string) data (undefined) required
automation_v4/delete_automation_v4_flows_by_flow_id	Fully delete a workflow by ID. Deleted workflows cannot be restored via the API. If you need to restore an accidentally deleted flow, you'll need to contact support.	flowId (integer)
blog_settings/post_cms_v3_blog_settings_settings_multi_language_update_languages	Explicitly set new languages for each blog in a multi-language group.	data: { . languages (object) . primaryId (string) } (object) required
blog_settings/get_cms_v3_blog_settings_settings_by_blog_id_revisions	Retrieves all the previous versions of a Blog	blogId (string) after (string) before (string) limit (integer)
blog_settings/get_cms_v3_blog_settings_settings_by_blog_id_revisions_by_revision_id	Retrieves a previous version of a Blog	blogId (string) revisionId (string)
blog_settings/get_cms_v3_blog_settings_settings_by_blog_id	Retrieve the Blog object identified by the id in the path.	blogId (string)
blog_settings/post_cms_v3_blog_settings_settings_multi_language_create_language_variation	Create a new language variation from an existing blog	data: { . language (string) . id (string) . primaryLanguage (string) . slug (string) } (object) required
blog_settings/get_cms_v3_blog_settings_settings	Get the list of Blogs. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean)
blog_settings/put_cms_v3_blog_settings_settings_multi_language_set_new_lang_primary	Set a blog as the primary language of a multi-language group.	data: { . id (string) } (object) required
blog_settings/post_cms_v3_blog_settings_settings_multi_language_detach_from_lang_group	Detach a blog from a multi-language group.	data: { . id (string) } (object) required
blog_settings/post_cms_v3_blog_settings_settings_multi_language_attach_to_lang_group	Attach a blog to a multi-language group.	data: { . language (string) . id (string) . primaryId (string) . primaryLanguage (string) } (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_read	Read a batch of bucket_test111s by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
buckettest111/get_crm_v3_objects_bucket_test111s_by_bucket_test111id	Read an Object identified by bucketTest111Id. bucketTest111Id refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	bucketTest111Id (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
buckettest111/delete_crm_v3_objects_bucket_test111s_by_bucket_test111id	Move an Object identified by bucketTest111Id to the recycling bin.	bucketTest111Id (string)
buckettest111/patch_crm_v3_objects_bucket_test111s_by_bucket_test111id	Perform a partial update of an Object identified by bucketTest111Id. bucketTest111Id refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.	bucketTest111Id (string) idProperty (string) data: { . properties (object) } (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_archive	Archive a batch of bucket_test111s by ID	data: { . inputs (array) } (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_create	Create a batch of bucket_test111s	data: { . inputs (array) } (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_update	Update a batch of bucket_test111s	data: { . inputs (array) } (object) required
buckettest111/get_crm_v3_objects_bucket_test111s	Read a page of bucket_test111s. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
buckettest111/post_crm_v3_objects_bucket_test111s	Create a bucket_test111 with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard bucket_test111s is provided.	data: { . associations (array) . properties (object) } (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
business_units/get_business_units_v3_business_units_user_by_user_id	Get Business Units identified by userId. The userId refers to the user’s ID.	userId (string) properties (array) name (array)
calling_extensions/get_crm_v3_extensions_calling_by_app_id_settings	Retrieve the settings configured for the app.	appId (integer)
calling_extensions/post_crm_v3_extensions_calling_by_app_id_settings	Set the menu label, target iframe URL, and dimensions for your calling extension.	appId (integer) data: { . supportsCustomObjects (boolean) . usesRemote (boolean) . isReady (boolean) . name (string) . width (integer) . usesCallingWindow (boolean) . supportsInboundCalling (boolean) . url (string) . height (integer) } (object) required
calling_extensions/delete_crm_v3_extensions_calling_by_app_id_settings	Delete a calling extension. This will remove your service as an option for all connected accounts.	appId (integer)
calling_extensions/patch_crm_v3_extensions_calling_by_app_id_settings	Update existing calling extension settings.	appId (integer) data: { . supportsCustomObjects (boolean) . usesRemote (boolean) . isReady (boolean) . name (string) . width (integer) . usesCallingWindow (boolean) . supportsInboundCalling (boolean) . url (string) . height (integer) } (object) required
calling_extensions/get_crm_v3_extensions_calling_by_app_id_settings_recording	Retrieve the URL that is registered for call recordinghttps://developers.hubspot.com/docs/guides/apps/extensions/calling-extensions/recordings-and-transcriptions register-your-app-s-endpoint-with-hubspot-using-the-calling-settings-api.	appId (integer)
calling_extensions/post_crm_v3_extensions_calling_by_app_id_settings_recording	Register an external URL that HubSpot will use to retrieve call recordingshttps://developers.hubspot.com/docs/guides/apps/extensions/calling-extensions/recordings-and-transcriptions register-your-app-s-endpoint-with-hubspot-using-the-calling-settings-api.	appId (integer) data: { . urlToRetrieveAuthedRecording (string) } (object) required
calling_extensions/patch_crm_v3_extensions_calling_by_app_id_settings_recording	Update the URL that HubSpot will use to retrieve call recordingshttps://developers.hubspot.com/docs/guides/apps/extensions/calling-extensions/recordings-and-transcriptions register-your-app-s-endpoint-with-hubspot-using-the-calling-settings-api.	appId (integer) data: { . urlToRetrieveAuthedRecording (string) } (object) required
calling_extensions/post_crm_v3_extensions_calling_recordings_ready	Mark a call recording as ready for transcription, specifying the call by its ID engagementid.	data: { . engagementId (integer) } (object) required
calling_extensions/get_crm_v3_extensions_calling_by_app_id_settings_channel_connection	Retrieve the settings related to the app's channel connectionhttps://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling fetch-existing-channel-connection-settings.	appId (integer)
calling_extensions/post_crm_v3_extensions_calling_by_app_id_settings_channel_connection	Configure channel connection settingshttps://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling create-channel-connection-settings for the app.	appId (integer) data: { . isReady (boolean) . url (string) } (object) required
calling_extensions/delete_crm_v3_extensions_calling_by_app_id_settings_channel_connection	Delete the channel connection settingshttps://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling delete-existing-channel-connection-settings for the app.	appId (integer)
calling_extensions/patch_crm_v3_extensions_calling_by_app_id_settings_channel_connection	Update existing channel connection settingshttps://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling manage-the-webhook-settings-for-channel-connection for your app.	appId (integer) data: { . isReady (boolean) . url (string) } (object) required
calls/post_crm_v3_objects_calls_batch_read	Retrieve a batch of calls by ID.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
calls/get_crm_v3_objects_calls_by_call_id	Retrieve a call by its ID callId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	callId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
calls/delete_crm_v3_objects_calls_by_call_id	Delete a call by ID. A deleted call can be restored within 90 days of being deleted, but the recording will be permanently deleted. Learn more about restoring activity recordshttps://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record.	callId (string)
calls/patch_crm_v3_objects_calls_by_call_id	Update a call by ID. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	callId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
calls/post_crm_v3_objects_calls_batch_archive	Archive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about restoring activity recordshttps://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record.	data: { . inputs (array) } (object) required
calls/post_crm_v3_objects_calls_batch_create	Create a batch of calls. The inputs array can contain a properties object to define property values for each record, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . inputs (array) } (object) required
calls/post_crm_v3_objects_calls_batch_update	Update a batch of calls by ID.	data: { . inputs (array) } (object) required
calls/get_crm_v3_objects_calls	Retrieve all calls, using query parameters to specify the information that gets returned.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
calls/post_crm_v3_objects_calls	Create a single call. Include a properties object to define property values for the record, along with an associations array to define call associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
calls/post_crm_v3_objects_calls_batch_upsert	Create or update a batch of calls by ID callId or unique property value idProperty.	data: { . inputs (array) } (object) required
calls/post_crm_v3_objects_calls_search	Search for calls by filtering on properties, searching through associations, and sorting results. Learn more about CRM searchhttps://developers.hubspot.com/docs/guides/api/crm/search make-a-search-request.	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_spend_by_spend_id	Read a campaign spend item by its spendId	campaignGuid (string) spendId (integer)
campaigns_public_api/put_marketing_v3_campaigns_by_campaign_guid_spend_by_spend_id	Update a specific campaign spend item by ID	campaignGuid (string) spendId (integer) data: { . amount (number) . name (string) . description (string) . order (integer) } (object) required
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guid_spend_by_spend_id	Delete a specific campaign spend item by ID	campaignGuid (string) spendId (integer)
campaigns_public_api/post_marketing_v3_campaigns_batch_update	This endpoint updates a batch of campaigns based on the provided input data. The maximum number of items in a batch request is 50. If an empty string '' is passed for any property in the Batch Update, it will reset that property's value.	data: { . inputs (array) } (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_budget_by_budget_id	Get a specific budget item by ID	campaignGuid (string) budgetId (integer)
campaigns_public_api/put_marketing_v3_campaigns_by_campaign_guid_budget_by_budget_id	Update a specific budget item by ID	campaignGuid (string) budgetId (integer) data: { . amount (number) . name (string) . description (string) . order (integer) } (object) required
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guid_budget_by_budget_id	Delete a specific budget item by ID	campaignGuid (string) budgetId (integer)
campaigns_public_api/put_marketing_v3_campaigns_by_campaign_guid_assets_by_asset_type_by_asset_id	Associate a specified asset with a campaign. Important: Currently, only the following asset types can be associated and disassociated via the API: Forms, Static lists, External website pages	campaignGuid (string) assetType (string) assetId (string)
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guid_assets_by_asset_type_by_asset_id	Disassociate a specified asset from a campaign. Important: Currently, only the following asset types can be associated and disassociated via the API: Forms, Static lists, External website pages	campaignGuid (string) assetType (string) assetId (string)
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_budget_totals	Retrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget. Budget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer	campaignGuid (string)
campaigns_public_api/get_marketing_v3_campaigns	This endpoint allows users to search for and return a page of campaigns based on various query parameters. Users can filter by name, sort, and paginate through the campaigns, as well as control which properties are returned in the response.	sort (string) after (string) limit (integer) name (string) properties (array)
campaigns_public_api/post_marketing_v3_campaigns	Create a campaign with the given properties and return the campaign object, including the campaignGuid and created properties.	data: { . properties (object) } (object) required
campaigns_public_api/post_marketing_v3_campaigns_batch_read	This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request. If duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.	startDate (string) endDate (string) properties (array) data: { . inputs (array) } (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_reports_metrics	This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.	campaignGuid (string) startDate (string) endDate (string)
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_assets_by_asset_type	This endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type. Asset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.	campaignGuid (string) assetType (string) after (string) limit (string) startDate (string) endDate (string)
campaigns_public_api/post_marketing_v3_campaigns_batch_archive	This endpoint deletes a batch of campaigns. The maximum number of items in a batch request is 50. The response will always be 204 No Content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.	data: { . inputs (array) } (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_reports_revenue	Fetch revenue attribution report data for a specified campaign	campaignGuid (string) attributionModel (string) startDate (string) endDate (string)
campaigns_public_api/post_marketing_v3_campaigns_batch_create	This endpoint creates a batch of campaigns. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request.	data: { . inputs (array) } (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid	Get a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.	campaignGuid (string) startDate (string) endDate (string) properties (array)
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guid	Delete a specified campaign from the system. This call will return a 204 No Content response regardless of whether the campaignGuid provided corresponds to an existing campaign or not.	campaignGuid (string)
campaigns_public_api/patch_marketing_v3_campaigns_by_campaign_guid	Perform a partial update of a campaign identified by the specified campaignGuid. Provided property values will be overwritten. Read-only and non-existent properties will cause 400 error. If an empty string is passed for any property in the Batch Update, it will reset that property's value.	campaignGuid (string) data: { . properties (object) } (object) required
campaigns_public_api/post_marketing_v3_campaigns_by_campaign_guid_budget	Add a new budget item to the campaign	campaignGuid (string) data: { . amount (number) . name (string) . description (string) . order (integer) } (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_reports_contacts_by_contact_type	Fetch the list of contact IDs for the specified campaign and contact type	campaignGuid (string) contactType (string) startDate (string) endDate (string) limit (integer) after (string)
campaigns_public_api/post_marketing_v3_campaigns_by_campaign_guid_spend	Create a new campaign spend item	campaignGuid (string) data: { . amount (number) . name (string) . description (string) . order (integer) } (object) required
carts/post_crm_v3_objects_carts_batch_read	Retrieve a batch of carts by ID cartId or unique property value idProperty.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
carts/get_crm_v3_objects_carts_by_cart_id	Retrieve a cart by its ID cartId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	cartId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
carts/delete_crm_v3_objects_carts_by_cart_id	Archive a cart by ID. Archived carts can be restored within 90 days of deletion. Learn more about restoring recordshttps://knowledge.hubspot.com/records/restore-deleted-records.	cartId (string)
carts/patch_crm_v3_objects_carts_by_cart_id	Update a cart by ID cartId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	cartId (string) idProperty (string) data: { . properties (object) } (object) required
carts/post_crm_v3_objects_carts_batch_archive	Archives a batch of cart by ID. Archived carts can be restored within 90 days of deletion. Learn more about restoring recordshttps://knowledge.hubspot.com/records/restore-deleted-records.	data: { . inputs (array) } (object) required
carts/post_crm_v3_objects_carts_batch_create	Create a batch of carts. The inputs array can contain a properties object to define property values for each record, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . inputs (array) } (object) required
carts/post_crm_v3_objects_carts_batch_update	Update a batch of carts by ID cartId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	data: { . inputs (array) } (object) required
carts/get_crm_v3_objects_carts	Read a page of carts. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
carts/post_crm_v3_objects_carts	Create a single cart. Include a properties object to define property valueshttps://developers.hubspot.com/docs/guides/api/crm/properties for the cart, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . associations (array) . properties (object) } (object) required
carts/post_crm_v3_objects_carts_batch_upsert	Create and update a batch of carts by a unique property. Carts that don't exist will be created, while existing carts will be updated.	data: { . inputs (array) } (object) required
carts/post_crm_v3_objects_carts_search	Search for carts by filtering on properties, searching through associations, and sorting results. Learn more about CRM searchhttps://developers.hubspot.com/docs/guides/api/crm/search make-a-search-request.	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
cms_content_audit/get_cms_v3_audit_logs	Returns audit logs based on filters.	userId (array) eventType (array) objectType (array) objectId (array) after (string) before (string) limit (integer) sort (array)
commerce_payments/post_crm_v3_objects_commerce_payments_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
commerce_payments/get_crm_v3_objects_commerce_payments_by_commerce_payment_id	Read an Object identified by commercePaymentId. commercePaymentId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	commercePaymentId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
commerce_payments/delete_crm_v3_objects_commerce_payments_by_commerce_payment_id	Move an Object identified by commercePaymentId to the recycling bin.	commercePaymentId (string)
commerce_payments/patch_crm_v3_objects_commerce_payments_by_commerce_payment_id	Perform a partial update of an Object identified by commercePaymentIdor optionally a unique property value as specified by the idProperty query param. commercePaymentId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	commercePaymentId (string) idProperty (string) data: { . properties (object) } (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_archive	Archive a batch of commerce payments by ID	data: { . inputs (array) } (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_create	Create a batch of commerce payments	data: { . inputs (array) } (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_update	Update a batch of commerce payments by internal ID, or unique property values	data: { . inputs (array) } (object) required
commerce_payments/get_crm_v3_objects_commerce_payments	Read a page of commerce payments. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
commerce_payments/post_crm_v3_objects_commerce_payments	Create a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided.	data: { . associations (array) . properties (object) } (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
commerce_subscriptions/get_crm_v3_objects_subscriptions_by_subscription_id	Read an Object identified by subscriptionId. subscriptionId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	subscriptionId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
commerce_subscriptions/delete_crm_v3_objects_subscriptions_by_subscription_id	Move an Object identified by subscriptionId to the recycling bin.	subscriptionId (string)
commerce_subscriptions/patch_crm_v3_objects_subscriptions_by_subscription_id	Perform a partial update of an Object identified by subscriptionIdor optionally a unique property value as specified by the idProperty query param. subscriptionId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	subscriptionId (string) idProperty (string) data: { . properties (object) } (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_archive	Archive a batch of subscriptions by ID	data: { . inputs (array) } (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_create	Create a batch of subscriptions	data: { . inputs (array) } (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_update	Update a batch of subscriptions by internal ID, or unique property values	data: { . inputs (array) } (object) required
commerce_subscriptions/get_crm_v3_objects_subscriptions	Read a page of subscriptions. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
commerce_subscriptions/post_crm_v3_objects_subscriptions	Create a subscription with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard subscriptions is provided.	data: { . associations (array) . properties (object) } (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
communications/post_crm_v3_objects_communications_batch_read	Retrieve a batch of messages by ID communicationId or unique property value idProperty.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
communications/get_crm_v3_objects_communications_by_communication_id	Retrieve a message by its ID communicationId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	communicationId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
communications/delete_crm_v3_objects_communications_by_communication_id	Delete a message by ID. You can restore deleted messages within 90 days of deletion. Learn more about restoring activity recordshttps://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record.	communicationId (string)
communications/patch_crm_v3_objects_communications_by_communication_id	Update a message by ID communicationId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	communicationId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
communications/post_crm_v3_objects_communications_batch_archive	Delete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about restoring activity recordshttps://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record.	data: { . inputs (array) } (object) required
communications/post_crm_v3_objects_communications_batch_create	Create a batch of messages. The inputs array can contain a properties object to define property values for each message, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . inputs (array) } (object) required
communications/post_crm_v3_objects_communications_batch_update	Update a batch of messages by ID communicationId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	data: { . inputs (array) } (object) required
communications/get_crm_v3_objects_communications	Retrieve all messages, using query parameters to specify the information that gets returned.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
communications/post_crm_v3_objects_communications	Create a single message. Include a properties object to define property valueshttps://developers.hubspot.com/docs/guides/api/crm/engagements/communications properties, along with an associations array to define communication associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
communications/post_crm_v3_objects_communications_batch_upsert	Create and update a batch of messages by a unique property. Messages that don't exist will be created, while existing messages will be updated.	data: { . inputs (array) } (object) required
communications/post_crm_v3_objects_communications_search	Search for messages by filtering on properties, searching through associations, and sorting results. Learn more about CRM searchhttps://developers.hubspot.com/docs/guides/api/crm/search make-a-search-request.	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
companies/post_crm_v3_objects_companies_batch_read	Retrieve a batch of companies by ID companyId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
companies/get_crm_v3_objects_companies_by_company_id	Retrieve a company by its ID companyId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	companyId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
companies/delete_crm_v3_objects_companies_by_company_id	Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about restoring recordshttps://knowledge.hubspot.com/records/restore-deleted-records.	companyId (string)
companies/patch_crm_v3_objects_companies_by_company_id	Update a company by ID companyId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	companyId (string) idProperty (string) data: { . properties (object) } (object) required
companies/post_crm_v3_objects_companies_merge	Merge two company records. Learn more about merging recordshttps://knowledge.hubspot.com/records/merge-records.	data: { . objectIdToMerge (string) . primaryObjectId (string) } (object) required
companies/post_crm_v3_objects_companies_batch_archive	Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about restoring recordshttps://knowledge.hubspot.com/records/restore-deleted-records.	data: { . inputs (array) } (object) required
companies/post_crm_v3_objects_companies_batch_create	Create a batch of companies. The inputs array can contain a properties object to define property values for each company, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . inputs (array) } (object) required
companies/post_crm_v3_objects_companies_batch_update	Update a batch of companies by ID.	data: { . inputs (array) } (object) required
companies/get_crm_v3_objects_companies	Retrieve all companies, using query parameters to control the information that gets returned.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
companies/post_crm_v3_objects_companies	Create a single company. Include a properties object to define property valueshttps://developers.hubspot.com/docs/guides/api/crm/properties for the company, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . associations (array) . properties (object) } (object) required
companies/post_crm_v3_objects_companies_batch_upsert	Create or update companies identified by a unique property value as specified by the idProperty query parameter. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
companies/post_crm_v3_objects_companies_search	Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about CRM searchhttps://developers.hubspot.com/docs/guides/api/crm/search make-a-search-request.	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
contacts/post_crm_v3_objects_contacts_batch_read	Read a batch of contacts by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
contacts/get_crm_v3_objects_contacts_by_contact_id	Read an Object identified by contactId. contactId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	contactId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
contacts/delete_crm_v3_objects_contacts_by_contact_id	Move an Object identified by contactId to the recycling bin.	contactId (string)
contacts/patch_crm_v3_objects_contacts_by_contact_id	Perform a partial update of an Object identified by contactId. contactId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.	contactId (string) idProperty (string) data: { . properties (object) } (object) required
contacts/post_crm_v3_objects_contacts_merge	Merge two contacts with same type	data: { . objectIdToMerge (string) . primaryObjectId (string) } (object) required
contacts/post_crm_v3_objects_contacts_batch_archive	Archive a batch of contacts by ID	data: { . inputs (array) } (object) required
contacts/post_crm_v3_objects_contacts_batch_create	Create a batch of contacts	data: { . inputs (array) } (object) required
contacts/post_crm_v3_objects_contacts_batch_update	Update a batch of contacts	data: { . inputs (array) } (object) required
contacts/post_crm_v3_objects_contacts_gdpr_delete	Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.	data: { . idProperty (string) . objectId (string) } (object) required
contacts/get_crm_v3_objects_contacts	Read a page of contacts. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
contacts/post_crm_v3_objects_contacts	Create a contact with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard contacts is provided.	data: { . associations (array) . properties (object) } (object) required
contacts/post_crm_v3_objects_contacts_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
contracts/post_crm_v3_objects_by_object_type_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	objectType (string) archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
contracts/get_crm_v3_objects_by_object_type_by_object_id	Read an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	objectType (string) objectId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
contracts/delete_crm_v3_objects_by_object_type_by_object_id	Move an Object identified by objectId to the recycling bin.	objectType (string) objectId (string)
contracts/patch_crm_v3_objects_by_object_type_by_object_id	Perform a partial update of an Object identified by objectIdor optionally a unique property value as specified by the idProperty query param. objectId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	objectType (string) objectId (string) idProperty (string) data: { . properties (object) } (object) required
contracts/post_crm_v3_objects_by_object_type_batch_archive	Archive a batch of objects by ID	objectType (string) data: { . inputs (array) } (object) required
contracts/post_crm_v3_objects_by_object_type_batch_create	Create a batch of objects	objectType (string) data: { . inputs (array) } (object) required
contracts/post_crm_v3_objects_by_object_type_batch_update	Update a batch of objects by internal ID, or unique property values	objectType (string) data: { . inputs (array) } (object) required
contracts/get_crm_v3_objects_by_object_type	Read a page of objects. Control what is returned via the properties query param.	objectType (string) limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
contracts/post_crm_v3_objects_by_object_type	Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.	objectType (string) data: { . associations (array) . properties (object) } (object) required
contracts/post_crm_v3_objects_by_object_type_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	objectType (string) data: { . inputs (array) } (object) required
contracts/post_crm_v3_objects_by_object_type_search	No description available	objectType (string) data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
conversations_inbox_messages/get_conversations_v3_conversations_inboxes	Get conversations inboxes.	after (string) limit (integer) sort (array) defaultPageLength (integer) archived (boolean)
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_id	Returns a single thread.	threadId (integer) archived (boolean) association (array) property (string)
conversations_inbox_messages/delete_conversations_v3_conversations_threads_by_thread_id	Archives a single thread. The thread will be permanently deleted 30 days after placed in an archived state.	threadId (integer)
conversations_inbox_messages/patch_conversations_v3_conversations_threads_by_thread_id	Updates a single thread. Either a thread's status can be updated, or the thread can be restored.	threadId (integer) archived (boolean) data: { . archived (boolean) . status (string) } (object) required
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_id_messages_by_message_id_original_content	Returns the complete original text and rich text bodies of a message. This will be different from the text and rich text in the message itself if the message's truncationStatus is anything other than NOT_TRUNCATED.	threadId (integer) messageId (string) property (string)
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_id_messages	Get message history for a thread.	threadId (integer) after (string) limit (integer) sort (array) archived (boolean) property (string)
conversations_inbox_messages/post_conversations_v3_conversations_threads_by_thread_id_messages	Send a new message on a thread at the current timestamp.	threadId (integer) data (undefined) required
conversations_inbox_messages/post_conversations_v3_conversations_actors_batch_read	Resolve ActorIds to the underlying actors/participants.	property (string) data: { . inputs (array) } (object) required
conversations_inbox_messages/get_conversations_v3_conversations_channel_accounts	Get channel accounts.	channelId (array) inboxId (array) after (string) limit (integer) sort (array) defaultPageLength (integer) archived (boolean)
conversations_inbox_messages/get_conversations_v3_conversations_channels_by_channel_id	Get a single channel.	channelId (integer)
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_id_messages_by_message_id	Get a single message.	threadId (integer) messageId (string) property (string)
conversations_inbox_messages/get_conversations_v3_conversations_channels	Get channels.	after (string) limit (integer) sort (array) defaultPageLength (integer)
conversations_inbox_messages/get_conversations_v3_conversations_actors_by_actor_id	Get a single actor.	actorId (string) property (string)
conversations_inbox_messages/get_conversations_v3_conversations_threads	Get threads.	after (string) limit (integer) sort (array) inboxId (array) associatedContactId (integer) threadStatus (string) latestMessageTimestampAfter (string) archived (boolean) association (array) property (string)
conversations_inbox_messages/get_conversations_v3_conversations_channel_accounts_by_channel_account_id	Get a single channel account.	channelAccountId (integer) archived (boolean)
conversations_inbox_messages/get_conversations_v3_conversations_inboxes_by_inbox_id	Get a single conversations inbox.	inboxId (integer) archived (boolean)
courses/post_crm_v3_objects_by_object_type_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	objectType (string) archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
courses/get_crm_v3_objects_by_object_type_by_object_id	Read an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	objectType (string) objectId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
courses/delete_crm_v3_objects_by_object_type_by_object_id	Move an Object identified by objectId to the recycling bin.	objectType (string) objectId (string)
courses/patch_crm_v3_objects_by_object_type_by_object_id	Perform a partial update of an Object identified by objectIdor optionally a unique property value as specified by the idProperty query param. objectId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	objectType (string) objectId (string) idProperty (string) data: { . properties (object) } (object) required
courses/post_crm_v3_objects_by_object_type_batch_archive	Archive a batch of objects by ID	objectType (string) data: { . inputs (array) } (object) required
courses/post_crm_v3_objects_by_object_type_batch_create	Create a batch of objects	objectType (string) data: { . inputs (array) } (object) required
courses/post_crm_v3_objects_by_object_type_batch_update	Update a batch of objects by internal ID, or unique property values	objectType (string) data: { . inputs (array) } (object) required
courses/get_crm_v3_objects_by_object_type	Read a page of objects. Control what is returned via the properties query param.	objectType (string) limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
courses/post_crm_v3_objects_by_object_type	Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.	objectType (string) data: { . associations (array) . properties (object) } (object) required
courses/post_crm_v3_objects_by_object_type_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	objectType (string) data: { . inputs (array) } (object) required
courses/post_crm_v3_objects_by_object_type_search	No description available	objectType (string) data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
crm_owners/get_crm_v3_owners	Get a page of owners	email (string) after (string) limit (integer) archived (boolean)
crm_owners/get_crm_v3_owners_by_owner_id	Read an owner by given id or userId	ownerId (integer) idProperty (string) archived (boolean)
custom_channels/get_conversations_v3_custom_channels_by_channel_id	Retrieve the details about a custom channel. This API allows you to see a custom channel's current capabilties and other configuration metadata	channelId (integer)
custom_channels/delete_conversations_v3_custom_channels_by_channel_id	Use this API to archive a registered custom channel	channelId (integer)
custom_channels/patch_conversations_v3_custom_channels_by_channel_id	This endpoint can be used to update a channel's capabilities. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.	channelId (integer) data: { . channelDescription (object) . capabilities (object) . channelAccountConnectionRedirectUrl (object) . channelLogoUrl (object) . webhookUrl (object) } (object) required
custom_channels/get_conversations_v3_custom_channels_by_channel_id_messages_by_message_id	Get the PublicConversationsMessage that represents a message sent over a custom channel	channelId (integer) messageId (string)
custom_channels/patch_conversations_v3_custom_channels_by_channel_id_messages_by_message_id	Use this API to update a message's status to indicate if it was successfully sent, failed to send, or was read	channelId (integer) messageId (string) data: { . statusType (string) . errorMessage (string) } (object) required
custom_channels/patch_conversations_v3_custom_channels_by_channel_id_channel_account_staging_tokens_by_account_token	This API is used for integrators creating public apps. Use this API to update a channel account staging token's account name and delivery identifier. This information will be applied to the channel account created from this staging token.	channelId (integer) accountToken (string) data: { . accountName (string) . deliveryIdentifier } (object) required
custom_channels/get_conversations_v3_custom_channels_by_channel_id_channel_accounts	Query channel accounts	channelId (integer) deliveryIdentifierType (array) deliveryIdentifierValue (array) after (string) limit (integer) sort (array) defaultPageLength (integer) archived (boolean)
custom_channels/post_conversations_v3_custom_channels_by_channel_id_channel_accounts	This API allows you to create one or more accounts that all talk over a single channel but using different delivery identifiers.	channelId (integer) data: { . authorized (boolean) . name (string) . deliveryIdentifier . inboxId (string) } (object) required
custom_channels/get_conversations_v3_custom_channels_by_channel_id_channel_accounts_by_channel_account_id	Retrieve a PublicChannelAccount that contains all the metadata about your channel account. This includes information like its channel, associated inbox id, and delivery identifier information.	channelId (integer) channelAccountId (integer) archived (boolean)
custom_channels/patch_conversations_v3_custom_channels_by_channel_id_channel_accounts_by_channel_account_id	This API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account.	channelId (integer) channelAccountId (integer) data: { . authorized (boolean) . name (string) } (object) required
custom_channels/get_conversations_v3_custom_channels	Get all channels for app	after (string) limit (integer) sort (array) defaultPageLength (integer)
custom_channels/post_conversations_v3_custom_channels	Register a new channel along with its capabilities and the webhook url that will be used to receive messages published over the channel	data: { . channelDescription (string) . capabilities (object) . channelAccountConnectionRedirectUrl (string) . channelLogoUrl (string) . name (string) . webhookUrl (string) } (object) required
custom_channels/post_conversations_v3_custom_channels_by_channel_id_messages	Publish a message over your custom channel	channelId (integer) data: { . messageDirection (string) . attachments (array) . recipients (array) . integrationThreadId (string) . integrationIdempotencyId (string) . text (string) . richText (string) . channelAccountId (string) . senders (array) . inReplyToId (string) . timestamp (string) } (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_read	Read a batch of objects by internal ID, or unique property values	objectType (string) archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
custom_objects/get_crm_v3_objects_by_object_type_by_object_id	Read an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	objectType (string) objectId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
custom_objects/delete_crm_v3_objects_by_object_type_by_object_id	Move an Object identified by objectId to the recycling bin.	objectType (string) objectId (string)
custom_objects/patch_crm_v3_objects_by_object_type_by_object_id	Perform a partial update of an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.	objectType (string) objectId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
custom_objects/post_crm_v3_objects_by_object_type_merge	Merge two objects with same type	objectType (string) data: { . objectIdToMerge (string) . primaryObjectId (string) } (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_archive	Archive a batch of objects by ID	objectType (string) data: { . inputs (array) } (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_create	Create a batch of objects	objectType (string) data: { . inputs (array) } (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_update	Update a batch of objects	objectType (string) data: { . inputs (array) } (object) required
custom_objects/get_crm_v3_objects_by_object_type	Read a page of objects. Control what is returned via the properties query param.	objectType (string) limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
custom_objects/post_crm_v3_objects_by_object_type	Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.	objectType (string) data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_upsert	Create or update a batch of objects by unique property values	objectType (string) data: { . inputs (array) } (object) required
custom_objects/post_crm_v3_objects_by_object_type_search	No description available	objectType (string) data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
deals/post_crm_v3_objects_deals_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
deals/get_crm_v3_objects_deals_by_deal_id	Read an Object identified by dealId. dealId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	dealId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
deals/delete_crm_v3_objects_deals_by_deal_id	Move an Object identified by dealId to the recycling bin.	dealId (string)
deals/patch_crm_v3_objects_deals_by_deal_id	Perform a partial update of an Object identified by dealIdor optionally a unique property value as specified by the idProperty query param. dealId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	dealId (string) idProperty (string) data: { . properties (object) } (object) required
deals/post_crm_v3_objects_deals_merge	Merge two deals with same type	data: { . objectIdToMerge (string) . primaryObjectId (string) } (object) required
deals/post_crm_v3_objects_deals_batch_archive	Archive a batch of deals by ID	data: { . inputs (array) } (object) required
deals/post_crm_v3_objects_deals_batch_create	Create a batch of deals	data: { . inputs (array) } (object) required
deals/post_crm_v3_objects_deals_batch_update	Update a batch of deals by internal ID, or unique property values	data: { . inputs (array) } (object) required
deals/get_crm_v3_objects_deals	Read a page of deals. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
deals/post_crm_v3_objects_deals	Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.	data: { . associations (array) . properties (object) } (object) required
deals/post_crm_v3_objects_deals_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
deals/post_crm_v3_objects_deals_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
deal_splits/post_crm_v3_objects_deals_splits_batch_upsert	Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 100% and may have up to 8 decimal places	data: { . inputs (array) } (object) required
deal_splits/post_crm_v3_objects_deals_splits_batch_read	Read a batch of deal split objects by their associated deal object internal ID	data: { . inputs (array) } (object) required
discounts/post_crm_v3_objects_discounts_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
discounts/get_crm_v3_objects_discounts_by_discount_id	Read an Object identified by discountId. discountId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	discountId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
discounts/delete_crm_v3_objects_discounts_by_discount_id	Move an Object identified by discountId to the recycling bin.	discountId (string)
discounts/patch_crm_v3_objects_discounts_by_discount_id	Perform a partial update of an Object identified by discountIdor optionally a unique property value as specified by the idProperty query param. discountId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	discountId (string) idProperty (string) data: { . properties (object) } (object) required
discounts/post_crm_v3_objects_discounts_batch_archive	Archive a batch of discounts by ID	data: { . inputs (array) } (object) required
discounts/post_crm_v3_objects_discounts_batch_create	Create a batch of discounts	data: { . inputs (array) } (object) required
discounts/post_crm_v3_objects_discounts_batch_update	Update a batch of discounts by internal ID, or unique property values	data: { . inputs (array) } (object) required
discounts/get_crm_v3_objects_discounts	Read a page of discounts. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
discounts/post_crm_v3_objects_discounts	Create a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided.	data: { . associations (array) . properties (object) } (object) required
discounts/post_crm_v3_objects_discounts_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
discounts/post_crm_v3_objects_discounts_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
domains/get_cms_v3_domains	Returns all existing domains that have been created. Results can be limited and filtered by creation or updated date.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean)
domains/get_cms_v3_domains_by_domain_id	Returns a single domains with the id specified.	domainId (string)
emails/post_crm_v3_objects_emails_batch_read	Read a batch of emails by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
emails/get_crm_v3_objects_emails_by_email_id	Read an Object identified by emailId. emailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	emailId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
emails/delete_crm_v3_objects_emails_by_email_id	Move an Object identified by emailId to the recycling bin.	emailId (string)
emails/patch_crm_v3_objects_emails_by_email_id	Perform a partial update of an Object identified by emailId. emailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.	emailId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
emails/post_crm_v3_objects_emails_batch_archive	Archive a batch of emails by ID	data: { . inputs (array) } (object) required
emails/post_crm_v3_objects_emails_batch_create	Create a batch of emails	data: { . inputs (array) } (object) required
emails/post_crm_v3_objects_emails_batch_update	Update a batch of emails	data: { . inputs (array) } (object) required
emails/get_crm_v3_objects_emails	Read a page of emails. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
emails/post_crm_v3_objects_emails	Create a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
emails/post_crm_v3_objects_emails_batch_upsert	Create or update a batch of emails by unique property values	data: { . inputs (array) } (object) required
emails/post_crm_v3_objects_emails_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
events/get_events_v3_events	Retrieve instances of event completion data. For example, retrieve all event completions associated with a specific contact.	objectType (string) eventType (string) after (string) before (string) limit (integer) sort (array) occurredAfter (string) occurredBefore (string) objectId (integer) objectProperty.propname (object) property.propname (object) id (array)
events/get_events_v3_events_event_types	This endpoint returns a list of event type names which are visible to you. You may use these event type names to query the API for specific event instances of a desired type.	No parameters
exports/get_crm_v3_exports_export_async_tasks_by_task_id_status	Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE	taskId (integer)
exports/post_crm_v3_exports_export_async	Begins exporting CRM data for the portal as specified in the request body	data (undefined) required
feedback_submissions/post_crm_v3_objects_feedback_submissions_batch_read	Read a batch of feedback submissions by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
feedback_submissions/get_crm_v3_objects_feedback_submissions_by_feedback_submission_id	Read an Object identified by feedbackSubmissionId. feedbackSubmissionId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	feedbackSubmissionId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
feedback_submissions/get_crm_v3_objects_feedback_submissions	Read a page of feedback submissions. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
feedback_submissions/post_crm_v3_objects_feedback_submissions_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
fees/post_crm_v3_objects_fees_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
fees/get_crm_v3_objects_fees_by_fee_id	Read an Object identified by feeId. feeId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	feeId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
fees/delete_crm_v3_objects_fees_by_fee_id	Move an Object identified by feeId to the recycling bin.	feeId (string)
fees/patch_crm_v3_objects_fees_by_fee_id	Perform a partial update of an Object identified by feeIdor optionally a unique property value as specified by the idProperty query param. feeId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	feeId (string) idProperty (string) data: { . properties (object) } (object) required
fees/post_crm_v3_objects_fees_batch_archive	Archive a batch of fees by ID	data: { . inputs (array) } (object) required
fees/post_crm_v3_objects_fees_batch_create	Create a batch of fees	data: { . inputs (array) } (object) required
fees/post_crm_v3_objects_fees_batch_update	Update a batch of fees by internal ID, or unique property values	data: { . inputs (array) } (object) required
fees/get_crm_v3_objects_fees	Read a page of fees. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
fees/post_crm_v3_objects_fees	Create a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided.	data: { . associations (array) . properties (object) } (object) required
fees/post_crm_v3_objects_fees_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
fees/post_crm_v3_objects_fees_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
files/delete_files_v3_files_by_file_id_gdpr_delete	Delete a file in accordance with GDPR regulations.	fileId (string)
files/get_files_v3_files_by_file_id	Retrieve a file by its ID.	fileId (string) properties (array)
files/put_files_v3_files_by_file_id	Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references.	fileId (string)
files/delete_files_v3_files_by_file_id	Delete a file by ID	fileId (string)
files/patch_files_v3_files_by_file_id	Update properties of file by ID.	fileId (string) data: { . access (string) . parentFolderId (string) . name (string) . parentFolderPath (string) . clearExpires (boolean) . isUsableInContent (boolean) . expiresAt (string) } (object) required
files/get_files_v3_folders_by_folder_id	Retrieve a folder by its ID.	folderId (string) properties (array)
files/delete_files_v3_folders_by_folder_id	Delete folder by ID.	folderId (string)
files/patch_files_v3_folders_by_folder_id	Update a folder's properties, identified by folder ID.	folderId (string) data: { . parentFolderId (integer) . name (string) } (object) required
files/post_files_v3_files	Upload a single file with content specified in request body.	No parameters
files/post_files_v3_folders	Creates a folder.	data: { . parentFolderId (string) . parentPath (string) . name (string) } (object) required
files/get_files_v3_files_by_file_id_signed_url	Generates signed URL that allows temporary access to a private file.	fileId (string) size (string) expirationSeconds (integer) upscale (boolean)
files/post_files_v3_files_import_from_url_async	Asynchronously imports the file at the given URL into the file manager.	data: { . folderPath (string) . access (string) . duplicateValidationScope (string) . name (string) . duplicateValidationStrategy (string) . ttl (string) . overwrite (boolean) . expiresAt (string) . url (string) . folderId (string) } (object) required
files/get_files_v3_files_stat_by_path	Retrieve a file by its path.	path (string) properties (array)
files/get_files_v3_folders_search	Search for folders. Does not contain hidden or archived folders.	properties (array) after (string) before (string) limit (integer) sort (array) ids (array) idLte (integer) idGte (integer) createdAt (string) createdAtLte (string) createdAtGte (string) updatedAt (string) updatedAtLte (string) updatedAtGte (string) name (string) path (string) parentFolderIds (array)
files/get_files_v3_folders_update_async_tasks_by_task_id_status	Check status of folder update. Folder updates happen asynchronously.	taskId (string)
files/get_files_v3_files_search	Search through files in the file manager. Does not display hidden or archived files.	properties (array) after (string) before (string) limit (integer) sort (array) ids (array) idLte (integer) idGte (integer) createdAt (string) createdAtLte (string) createdAtGte (string) updatedAt (string) updatedAtLte (string) updatedAtGte (string) name (string) path (string) parentFolderIds (array) size (integer) sizeLte (integer) sizeGte (integer) height (integer) heightLte (integer) heightGte (integer) width (integer) widthLte (integer) widthGte (integer) encoding (string) type (string) extension (string) url (string) isUsableInContent (boolean) allowsAnonymousAccess (boolean) fileMd5 (string) expiresAt (string) expiresAtLte (string) expiresAtGte (string)
files/get_files_v3_folders_by_folder_path	Retrieve a folder, identified by its path.	folderPath (string) properties (array)
files/delete_files_v3_folders_by_folder_path	Delete a folder, identified by its path.	folderPath (string)
files/post_files_v3_folders_update_async	Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well.	data: { . parentFolderId (integer) . name (string) . id (string) } (object) required
files/get_files_v3_files_import_from_url_async_tasks_by_task_id_status	Check the status of requested import.	taskId (string)
forms/get_marketing_v3_forms_by_form_id	Returns a form based on the form ID provided.	formId (string) archived (boolean)
forms/put_marketing_v3_forms_by_form_id	Update all fields of a hubspot form definition.	formId (string) data (undefined) required
forms/delete_marketing_v3_forms_by_form_id	Archive a form definition. New submissions will not be accepted and the form definition will be permanently deleted after 3 months.	formId (string)
forms/patch_marketing_v3_forms_by_form_id	Update some of the form definition components	formId (string) data: { . fieldGroups (array) . archived (boolean) . configuration . name (string) . legalConsentOptions . displayOptions } (object) required
forms/get_marketing_v3_forms	Returns a list of forms based on the search filters. By default, it returns the first 20 hubspot forms	after (string) limit (integer) archived (boolean) formTypes (array)
forms/post_marketing_v3_forms	Add a new hubspot form	data (undefined) required
goal_targets/post_crm_v3_objects_goal_targets_batch_read	Read a batch of goal targets by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
goal_targets/get_crm_v3_objects_goal_targets_by_goal_target_id	Read an Object identified by goalTargetId. goalTargetId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	goalTargetId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
goal_targets/delete_crm_v3_objects_goal_targets_by_goal_target_id	Move an Object identified by goalTargetId to the recycling bin.	goalTargetId (string)
goal_targets/patch_crm_v3_objects_goal_targets_by_goal_target_id	Perform a partial update of an Object identified by goalTargetIdor optionally a unique property value as specified by the idProperty query param. goalTargetId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	goalTargetId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_archive	Archive a batch of goal targets by ID	data: { . inputs (array) } (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_create	Create a batch of goal targets	data: { . inputs (array) } (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_update	Update a batch of goal targets by internal ID, or unique property values	data: { . inputs (array) } (object) required
goal_targets/get_crm_v3_objects_goal_targets	Read a page of goal targets. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
goal_targets/post_crm_v3_objects_goal_targets	Create a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
goal_targets/post_crm_v3_objects_goal_targets_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_draft_export	Exports the draft version of a table to CSV / EXCEL format.	tableIdOrName (string) format (string)
hubdb/get_cms_v3_hubdb_tables_draft	Returns the details for each draft table defined in the specified account, including column definitions.	sort (array) after (string) limit (integer) createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) contentType (string) archived (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft	Returns rows in the draft version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5 and sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview sectionhttps://developers.hubspot.com/docs/api/cms/hubdb filtering-and-sorting-table-rows for detailed fil	tableIdOrName (string) sort (array) after (string) limit (integer) properties (array) offset (integer) archived (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id	Get a single row by ID from the published version of a table. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.	tableIdOrName (string) rowId (string) archived (boolean)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_draft_clone	Clones a single row in the draft version of a table.	tableIdOrName (string) rowId (string) name (string)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_reset	Replaces the data in the draft version of the table with values from the published version. Any unpublished changes in the draft will be lost after this call is made.	tableIdOrName (string) includeForeignIds (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_export	Exports the published version of a table in a specified format.	tableIdOrName (string) format (string)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_replace	Replaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PUT /tables/tableIdOrName/rows/rowId/draft for details on updating a single row.	tableIdOrName (string) data: { . inputs (array) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_clone	Clone an existing HubDB table. The newName and newLabel of the new table can be sent as JSON in the request body. This will create the cloned table as a draft.	tableIdOrName (string) data: { . newName (string) . isHubspotDefined (boolean) . newLabel (string) . copyRows (boolean) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_purge	Permanently deletes rows from the draft version of the table, given a set of row IDs. Maximum of 100 row IDs per call.	tableIdOrName (string) data: { . inputs (array) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_import	Import the contents of a CSV file into an existing HubDB table. The data will always be imported into the draft version of the table. Use the /publish endpoint to push these changes to the published version. This endpoint takes a multi-part POST request. The first part will be a set of JSON-formatted options for the import and you can specify this with the name as config. The second part will be the CSV file you want to import and you can specify this with the name as file. Refer the overview s	tableIdOrName (string)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_draft	Get a single row by ID from a table's draft version.	tableIdOrName (string) rowId (string) archived (boolean)
hubdb/put_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_draft	Replace a single row in the draft version of a table. All column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted. See the 'Create a row' endpoint for instructions on how to format the JSON row definitions.	tableIdOrName (string) rowId (string) data: { . path (string) . childTableId (integer) . values (object) . name (string) . displayIndex (integer) } (object) required
hubdb/delete_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_draft	Permanently deletes a row from a table's draft version.	tableIdOrName (string) rowId (string)
hubdb/patch_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_draft	Sparse updates a single row in the table's draft version. All the column values need not be specified. Only the columns or fields that needs to be modified can be specified. See the 'Create a row' endpoint for instructions on how to format the JSON row definitions.	tableIdOrName (string) rowId (string) data: { . path (string) . childTableId (integer) . values (object) . name (string) . displayIndex (integer) } (object) required
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rows	Returns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5 and sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview sectionhttps://developers.hubspot.com/docs/api/cms/hubdb filtering-and-sorting-table-rows for	tableIdOrName (string) sort (array) after (string) limit (integer) properties (array) offset (integer) archived (boolean)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows	Add a new row to a HubDB table. New rows will be added to the draft version of the table. Use the /publish endpoint to push these changes to published version.	tableIdOrName (string) data: { . path (string) . childTableId (integer) . values (object) . name (string) . displayIndex (integer) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_batch_read	Returns rows in the published version of the specified table, given a set of row IDs. Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access.	tableIdOrName (string) data: { . inputs (array) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_create	Creates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example.	tableIdOrName (string) data: { . inputs (array) } (object) required
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name	Returns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table. Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access. To do so, you'll need to include the HubSpot account ID in a portalId query parameter.	tableIdOrName (string) isGetLocalizedSchema (boolean) archived (boolean) includeForeignIds (boolean)
hubdb/delete_cms_v3_hubdb_tables_by_table_id_or_name	Archive soft delete an existing HubDB table. This archives both the published and draft versions.	tableIdOrName (string)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_read	Returns rows in the draft version of the specified table, given a set of row IDs.	tableIdOrName (string) data: { . inputs (array) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_clone	Clones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call.	tableIdOrName (string) data: { . inputs (array) } (object) required
hubdb/get_cms_v3_hubdb_tables	Returns the details for the published version of each table defined in an account, including column definitions.	sort (array) after (string) limit (integer) createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) contentType (string) archived (boolean)
hubdb/post_cms_v3_hubdb_tables	Creates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.	data: { . dynamicMetaTags (object) . allowPublicApiAccess (boolean) . useForPages (boolean) . columns (array) . name (string) . enableChildTablePages (boolean) . label (string) . allowChildTables (boolean) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_unpublish	Unpublishes the table, meaning any website pages using data from the table will not render any data.	tableIdOrName (string) includeForeignIds (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_draft	Get the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.	tableIdOrName (string) isGetLocalizedSchema (boolean) archived (boolean) includeForeignIds (boolean)
hubdb/patch_cms_v3_hubdb_tables_by_table_id_or_name_draft	Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use the /publish endpoint to push all the changes to the published version. To restore a table, include the query parameter archived=true and 'archived': false in the json body. Note: You need to include all the columns in the input when you are adding/removing/updating a column. If	tableIdOrName (string) isGetLocalizedSchema (boolean) archived (boolean) includeForeignIds (boolean) data: { . dynamicMetaTags (object) . allowPublicApiAccess (boolean) . useForPages (boolean) . columns (array) . name (string) . enableChildTablePages (boolean) . label (string) . allowChildTables (boolean) } (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_publish	Publishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated.	tableIdOrName (string) includeForeignIds (boolean)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_update	Updates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PATCH /tables/tableIdOrName/rows/rowId/draft for details on updating a single row.	tableIdOrName (string) data: { . inputs (array) } (object) required
imports/post_crm_v3_imports_by_import_id_cancel	This allows a developer to cancel an active import.	importId (integer)
imports/get_crm_v3_imports_by_import_id	A complete summary of an import record, including any updates.	importId (integer)
imports/get_crm_v3_imports_by_import_id_errors	No description available	importId (integer) after (string) limit (integer) includeErrorMessage (boolean) includeRowData (boolean)
imports/get_crm_v3_imports	Returns a paged list of active imports for this account.	after (string) before (string) limit (integer)
imports/post_crm_v3_imports	Begins importing data from the specified file resources. This uploads the corresponding file and uses the import request object to convert rows in the files to objects.	No parameters
invoices/post_crm_v3_objects_invoices_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
invoices/get_crm_v3_objects_invoices_by_invoice_id	Read an Object identified by invoiceId. invoiceId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	invoiceId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
invoices/delete_crm_v3_objects_invoices_by_invoice_id	Move an Object identified by invoiceId to the recycling bin.	invoiceId (string)
invoices/patch_crm_v3_objects_invoices_by_invoice_id	Perform a partial update of an Object identified by invoiceIdor optionally a unique property value as specified by the idProperty query param. invoiceId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	invoiceId (string) idProperty (string) data: { . properties (object) } (object) required
invoices/post_crm_v3_objects_invoices_batch_archive	Archive a batch of invoices by ID	data: { . inputs (array) } (object) required
invoices/post_crm_v3_objects_invoices_batch_create	Create a batch of invoices	data: { . inputs (array) } (object) required
invoices/post_crm_v3_objects_invoices_batch_update	Update a batch of invoices by internal ID, or unique property values	data: { . inputs (array) } (object) required
invoices/get_crm_v3_objects_invoices	Read a page of invoices. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
invoices/post_crm_v3_objects_invoices	Create a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided.	data: { . associations (array) . properties (object) } (object) required
invoices/post_crm_v3_objects_invoices_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
invoices/post_crm_v3_objects_invoices_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
leads/post_crm_v3_objects_leads_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
leads/get_crm_v3_objects_leads_by_leads_id	Read an Object identified by leadsId. leadsId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	leadsId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
leads/delete_crm_v3_objects_leads_by_leads_id	Move an Object identified by leadsId to the recycling bin.	leadsId (string)
leads/patch_crm_v3_objects_leads_by_leads_id	Perform a partial update of an Object identified by leadsIdor optionally a unique property value as specified by the idProperty query param. leadsId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	leadsId (string) idProperty (string) data: { . properties (object) } (object) required
leads/post_crm_v3_objects_leads_batch_archive	Archive a batch of leads by ID	data: { . inputs (array) } (object) required
leads/post_crm_v3_objects_leads_batch_create	Create a batch of leads	data: { . inputs (array) } (object) required
leads/post_crm_v3_objects_leads_batch_update	Update a batch of leads by internal ID, or unique property values	data: { . inputs (array) } (object) required
leads/get_crm_v3_objects_leads	Read a page of leads. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
leads/post_crm_v3_objects_leads	Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.	data: { . associations (array) . properties (object) } (object) required
leads/post_crm_v3_objects_leads_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
limits_tracking/get_crm_v3_limits_associations_labels	Returns limits and usage for custom association labels	fromObjectTypeId (string) toObjectTypeId (string)
limits_tracking/get_crm_v3_limits_associations_records_by_from_object_type_id_by_to_object_type_id	Returns records approaching or at association limits between two objects	fromObjectTypeId (string) toObjectTypeId (string)
limits_tracking/get_crm_v3_limits_associations_records_by_from_object_type_id_to	Returns objects for which the from object has records approaching or at association limits	fromObjectTypeId (string)
limits_tracking/get_crm_v3_limits_custom_object_types	Returns limits and usage for custom object schemas	No parameters
limits_tracking/get_crm_v3_limits_custom_properties	Returns limits and usage per object for custom properties	No parameters
limits_tracking/get_crm_v3_limits_associations_records_from	Returns objects with records approaching or at association limits	No parameters
limits_tracking/get_crm_v3_limits_records	Returns limits and usage per object for records	No parameters
limits_tracking/get_crm_v3_limits_pipelines	Returns limits and usage per object for pipelines	No parameters
limits_tracking/get_crm_v3_limits_calculated_properties	Returns overall limit and per object usage for calculated properties	No parameters
line_items/post_crm_v3_objects_line_items_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
line_items/get_crm_v3_objects_line_items_by_line_item_id	Read an Object identified by lineItemId. lineItemId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	lineItemId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
line_items/delete_crm_v3_objects_line_items_by_line_item_id	Move an Object identified by lineItemId to the recycling bin.	lineItemId (string)
line_items/patch_crm_v3_objects_line_items_by_line_item_id	Perform a partial update of an Object identified by lineItemIdor optionally a unique property value as specified by the idProperty query param. lineItemId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	lineItemId (string) idProperty (string) data: { . properties (object) } (object) required
line_items/post_crm_v3_objects_line_items_batch_archive	Archive a batch of line items by ID	data: { . inputs (array) } (object) required
line_items/post_crm_v3_objects_line_items_batch_create	Create a batch of line items	data: { . inputs (array) } (object) required
line_items/post_crm_v3_objects_line_items_batch_update	Update a batch of line items by internal ID, or unique property values	data: { . inputs (array) } (object) required
line_items/get_crm_v3_objects_line_items	Read a page of line items. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
line_items/post_crm_v3_objects_line_items	Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.	data: { . associations (array) . properties (object) } (object) required
line_items/post_crm_v3_objects_line_items_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
line_items/post_crm_v3_objects_line_items_search	Search for line items by filtering on properties, searching through associations, and sorting results. Learn more about CRM searchhttps://developers.hubspot.com/docs/guides/api/crm/search make-a-search-request.	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
listings/post_crm_v3_objects_by_object_type_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	objectType (string) archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
listings/get_crm_v3_objects_by_object_type_by_object_id	Read an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	objectType (string) objectId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
listings/delete_crm_v3_objects_by_object_type_by_object_id	Move an Object identified by objectId to the recycling bin.	objectType (string) objectId (string)
listings/patch_crm_v3_objects_by_object_type_by_object_id	Perform a partial update of an Object identified by objectIdor optionally a unique property value as specified by the idProperty query param. objectId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	objectType (string) objectId (string) idProperty (string) data: { . properties (object) } (object) required
listings/post_crm_v3_objects_by_object_type_batch_archive	Archive a batch of objects by ID	objectType (string) data: { . inputs (array) } (object) required
listings/post_crm_v3_objects_by_object_type_batch_create	Create a batch of objects	objectType (string) data: { . inputs (array) } (object) required
listings/post_crm_v3_objects_by_object_type_batch_update	Update a batch of objects by internal ID, or unique property values	objectType (string) data: { . inputs (array) } (object) required
listings/get_crm_v3_objects_by_object_type	Read a page of objects. Control what is returned via the properties query param.	objectType (string) limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
listings/post_crm_v3_objects_by_object_type	Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.	objectType (string) data: { . associations (array) . properties (object) } (object) required
listings/post_crm_v3_objects_by_object_type_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	objectType (string) data: { . inputs (array) } (object) required
listings/post_crm_v3_objects_by_object_type_search	No description available	objectType (string) data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
lists/put_crm_v3_lists_by_list_id_update_list_name	Update the name of a list. The name must be globally unique relative to all other public lists in the portal.	listId (string) listName (string) includeFilters (boolean)
lists/put_crm_v3_lists_by_list_id_memberships_add_and_remove	Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.	listId (string) data: { . recordIdsToRemove (array) . recordIdsToAdd (array) } (object) required
lists/get_crm_v3_lists_by_list_id	Fetch a single list by ILS list ID.	listId (string) includeFilters (boolean)
lists/delete_crm_v3_lists_by_list_id	Delete a list by ILS list ID. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored.	listId (string)
lists/put_crm_v3_lists_by_list_id_update_list_filters	Update the filter branch definition of a DYNAMIC list. Once updated, the list memberships will be re-evaluated and updated to match the new definition.	listId (string) enrollObjectsInWorkflows (boolean) data: { . filterBranch } (object) required
lists/get_crm_v3_lists_by_list_id_schedule_conversion	No description available	listId (string)
lists/put_crm_v3_lists_by_list_id_schedule_conversion	No description available	listId (string) data (undefined) required
lists/delete_crm_v3_lists_by_list_id_schedule_conversion	No description available	listId (string)
lists/post_crm_v3_lists_search	Search lists by list name or page through all lists by providing an empty query value.	data: { . listIds (array) . offset (integer) . query (string) . count (integer) . processingTypes (array) . additionalProperties (array) . sort (string) } (object) required
lists/put_crm_v3_lists_folders_move_list	Given a list and a folder, the list will be moved to that folder.	data: { . listId (string) . newFolderId (string) } (object) required
lists/put_crm_v3_lists_by_list_id_memberships_add	Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.	listId (string) data (array) required
lists/get_crm_v3_lists_object_type_id_by_object_type_id_name_by_list_name	Fetch a single list by list name and object type.	listName (string) objectTypeId (string) includeFilters (boolean)
lists/put_crm_v3_lists_folders_by_folder_id_move_by_new_parent_folder_id	This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given.	folderId (string) newParentFolderId (string)
lists/get_crm_v3_lists_idmapping	This API allows translation of legacy list id to list id. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.	legacyListId (string)
lists/post_crm_v3_lists_idmapping	This API allows translation of a batch of legacy list id's to list id's. This allows for a maximum of 10,000 id's. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.	data (array) required
lists/put_crm_v3_lists_by_list_id_restore	Restore a previously deleted list by ILS list ID. Deleted lists are eligible to be restored up-to 90-days after the list has been deleted.	listId (string)
lists/put_crm_v3_lists_folders_by_folder_id_rename	Renames the given folderId with a new name.	folderId (string) newFolderName (string)
lists/get_crm_v3_lists_by_list_id_memberships_join_order	Fetch the memberships of a list in order sorted by the time the records were added to the list. The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order. The after offset parameter will take precedence over the before offset in a case where both are provided.	listId (string) after (string) before (string) limit (integer)
lists/put_crm_v3_lists_by_list_id_memberships_add_from_by_source_list_id	Add all of the records from a source list specified by the sourceListId to a destination list specified by the listId. Records that are already members of the destination list will be ignored. The destination and source list IDs must be different. The destination and source lists must contain records of the same type e.g. contacts, companies, etc.. This endpoint only works for destination lists that have a processingType of MANUAL or SNAPSHOT. The source list can have any processingType. This	listId (string) sourceListId (string)
lists/get_crm_v3_lists_records_by_object_type_id_by_record_id_memberships	For given record provide lists this record is member of.	objectTypeId (string) recordId (string)
lists/get_crm_v3_lists	Fetch multiple lists in a single request by ILS list ID. The response will include the definitions of all lists that exist for the listIds provided.	listIds (array) includeFilters (boolean)
lists/post_crm_v3_lists	Create a new list with the provided object list definition.	data: { . membershipSettings . objectTypeId (string) . processingType (string) . customProperties (object) . listFolderId (integer) . name (string) . listPermissions . filterBranch } (object) required
lists/get_crm_v3_lists_folders	Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder.	folderId (string)
lists/post_crm_v3_lists_folders	Creates a folder with the given information.	data: { . parentFolderId (string) . name (string) } (object) required
lists/delete_crm_v3_lists_folders_by_folder_id	Deletes the folder with the given Id.	folderId (string)
lists/get_crm_v3_lists_by_list_id_memberships	Fetch the memberships of a list in order sorted by the recordId of the records in the list. The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order. The after offset parameter will take precedence over the before offset in a case where both are provided.	listId (string) after (string) before (string) limit (integer)
lists/delete_crm_v3_lists_by_list_id_memberships	Remove all of the records from a list. Note: The list is not deleted. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT. This endpoint only supports lists that have less than 100,000 memberships.	listId (string)
lists/put_crm_v3_lists_by_list_id_memberships_remove	Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.	listId (string) data (array) required
manage_event_definitions/get_events_v3_event_definitions	Retrieve existing custom event definitions.	searchString (string) after (string) limit (integer) includeProperties (boolean) sortOrder (string)
manage_event_definitions/post_events_v3_event_definitions	Create a custom event definition.	data: { . propertyDefinitions (array) . name (string) . description (string) . label (string) . primaryObject (string) } (object) required
manage_event_definitions/get_events_v3_event_definitions_by_event_name	Fetch a single custom event definition by name.	eventName (string)
manage_event_definitions/delete_events_v3_event_definitions_by_event_name	Delete a custom event definition by name.	eventName (string)
manage_event_definitions/patch_events_v3_event_definitions_by_event_name	Update a specific custom event definition by name.	eventName (string) data: { . description (string) . label (string) } (object) required
manage_event_definitions/post_events_v3_event_definitions_by_event_name_property	Create a new property for an existing event definition.	eventName (string) data: { . name (string) . options (array) . description (string) . label (string) . type (string) } (object) required
manage_event_definitions/delete_events_v3_event_definitions_by_event_name_property_by_property_name	Delete an existing property from a custom event definition.	eventName (string) propertyName (string)
manage_event_definitions/patch_events_v3_event_definitions_by_event_name_property_by_property_name	Update an existing property in a custom event definition.	eventName (string) propertyName (string) data: { . options (array) . description (string) . label (string) } (object) required
marketing_emails/get_marketing_v3_emails_statistics_list	Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span.	startTimestamp (string) endTimestamp (string) emailIds (array) property (string)
marketing_emails/post_marketing_v3_emails_by_email_id_publish	If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email.	emailId (string)
marketing_emails/post_marketing_v3_emails_ab_test_create_variation	Create a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created.	data: { . variationName (string) . contentId (string) } (object) required
marketing_emails/get_marketing_v3_emails_statistics_histogram	Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time.	interval (string) startTimestamp (string) endTimestamp (string) emailIds (array)
marketing_emails/get_marketing_v3_emails_by_email_id_ab_test_get_variation	This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A master it will return variation B variant and vice versa.	emailId (string)
marketing_emails/post_marketing_v3_emails_by_email_id_draft_reset	Resets the draft back to a copy of the live object.	emailId (string)
marketing_emails/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restore_to_draft	Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten.	emailId (string) revisionId (integer)
marketing_emails/get_marketing_v3_emails_by_email_id_draft	Get the draft version of an email if it exists. If no draft version exists, the published email is returned.	emailId (string)
marketing_emails/patch_marketing_v3_emails_by_email_id_draft	Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.	emailId (string) data: { . rssData . subject (string) . testing . publishDate (string) . language (string) . businessUnitId (integer) . content . webversion . archived (boolean) . subscriptionDetails . activeDomain (string) . name (string) . campaign (string) . from . jitterSendTime (boolean) . state (string) . to . subcategory (string) . sendOnPublish (boolean) } (object) required
marketing_emails/get_marketing_v3_emails_by_email_id_revisions	Get a list of all versions of a marketing email, with each entry including the full state of that particular version. The current revision has the ID -1.	emailId (string) after (string) before (string) limit (integer)
marketing_emails/post_marketing_v3_emails_by_email_id_unpublish	If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible.	emailId (string)
marketing_emails/get_marketing_v3_emails_by_email_id_revisions_by_revision_id	Get a specific revision of a marketing email.	emailId (string) revisionId (string)
marketing_emails/post_marketing_v3_emails_clone	This will create a duplicate email with the same properties as the original, with the exception of a unique ID.	data: { . cloneName (string) . language (string) . id (string) } (object) required
marketing_emails/get_marketing_v3_emails	The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) includeStats (boolean) marketingCampaignNames (boolean) workflowNames (boolean) type (string) isPublished (boolean) includedProperties (array) campaign (string) archived (boolean)
marketing_emails/post_marketing_v3_emails	Use this endpoint to create a new marketing email.	data: { . feedbackSurveyId (string) . rssData . subject (string) . testing . publishDate (string) . language (string) . businessUnitId (integer) . content . webversion . archived (boolean) . subscriptionDetails . activeDomain (string) . name (string) . campaign (string) . from . jitterSendTime (boolean) . state (string) . to . subcategory (string) . sendOnPublish (boolean) } (object) required
marketing_emails/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restore	Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number.	emailId (string) revisionId (string)
marketing_emails/get_marketing_v3_emails_by_email_id	Get the details for a marketing email.	emailId (string) includeStats (boolean) marketingCampaignNames (boolean) workflowNames (boolean) includedProperties (array) archived (boolean)
marketing_emails/delete_marketing_v3_emails_by_email_id	Delete a marketing email.	emailId (string) archived (boolean)
marketing_emails/patch_marketing_v3_emails_by_email_id	Change properties of a marketing email.	emailId (string) archived (boolean) data: { . rssData . subject (string) . testing . publishDate (string) . language (string) . businessUnitId (integer) . content . webversion . archived (boolean) . subscriptionDetails . activeDomain (string) . name (string) . campaign (string) . from . jitterSendTime (boolean) . state (string) . to . subcategory (string) . sendOnPublish (boolean) } (object) required
marketing_emails_v3/get_marketing_v3_emails_statistics_list	Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span.	startTimestamp (string) endTimestamp (string) emailIds (array) property (string)
marketing_emails_v3/post_marketing_v3_emails_ab_test_create_variation	No description available	data: { . variationName (string) . contentId (string) } (object) required
marketing_emails_v3/get_marketing_v3_emails_statistics_histogram	Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time.	interval (string) startTimestamp (string) endTimestamp (string) emailIds (array)
marketing_emails_v3/get_marketing_v3_emails_by_email_id_ab_test_get_variation	This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A master it will return variation B variant and vice versa.	emailId (string)
marketing_emails_v3/post_marketing_v3_emails_by_email_id_draft_reset	Resets the draft back to a copy of the live object.	emailId (string)
marketing_emails_v3/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restore_to_draft	Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten.	emailId (string) revisionId (integer)
marketing_emails_v3/get_marketing_v3_emails_by_email_id_draft	Get the draft version of an email if it exists. If no draft version exists, the published email is returned.	emailId (string)
marketing_emails_v3/patch_marketing_v3_emails_by_email_id_draft	Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.	emailId (string) data: { . rssData . subject (string) . testing . publishDate (string) . language (string) . businessUnitId (string) . content . webversion . archived (boolean) . subscriptionDetails . activeDomain (string) . name (string) . campaign (string) . from . state (string) . to . subcategory (string) . sendOnPublish (boolean) } (object) required
marketing_emails_v3/get_marketing_v3_emails_by_email_id_revisions	Get a list of all versions of a marketing email, with each entry including the full state of that particular version. The current revision has the ID -1.	emailId (string) after (string) before (string) limit (integer)
marketing_emails_v3/get_marketing_v3_emails_by_email_id_revisions_by_revision_id	Get a specific revision of a marketing email.	emailId (string) revisionId (string)
marketing_emails_v3/post_marketing_v3_emails_clone	No description available	data: { . cloneName (string) . id (string) } (object) required
marketing_emails_v3/get_marketing_v3_emails	The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) includeStats (boolean) type (string) isPublished (boolean) includedProperties (array) archived (boolean)
marketing_emails_v3/post_marketing_v3_emails	Use this endpoint to create a new marketing email.	data: { . feedbackSurveyId (string) . rssData . subject (string) . testing . publishDate (string) . language (string) . businessUnitId (string) . content . webversion . archived (boolean) . subscriptionDetails . activeDomain (string) . name (string) . campaign (string) . from . state (string) . to . subcategory (string) . sendOnPublish (boolean) } (object) required
marketing_emails_v3/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restore	Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number.	emailId (string) revisionId (string)
marketing_emails_v3/get_marketing_v3_emails_by_email_id	Get the details for a marketing email.	emailId (string) includeStats (boolean) includedProperties (array) archived (boolean)
marketing_emails_v3/delete_marketing_v3_emails_by_email_id	Delete a marketing email.	emailId (string) archived (boolean)
marketing_emails_v3/patch_marketing_v3_emails_by_email_id	Change properties of a marketing email.	emailId (string) archived (boolean) data: { . rssData . subject (string) . testing . publishDate (string) . language (string) . businessUnitId (string) . content . webversion . archived (boolean) . subscriptionDetails . activeDomain (string) . name (string) . campaign (string) . from . state (string) . to . subcategory (string) . sendOnPublish (boolean) } (object) required
marketing_events/post_marketing_v3_marketing_events_attendance_by_external_event_id_by_subscriber_state_create	Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state 'attend': - joinedAt - leftAt	externalEventId (string) subscriberState (string) externalAccountId (string) data: { . inputs (array) } (object) required
marketing_events/get_marketing_v3_marketing_events_participations_by_marketing_event_id_breakdown	Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.	marketingEventId (integer) contactIdentifier (string) state (string) limit (integer) after (string)
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_by_subscriber_state_upsert	Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.	externalEventId (string) subscriberState (string) externalAccountId (string) required data: { . inputs (array) } (object) required
marketing_events/get_marketing_v3_marketing_events_events_by_external_event_id	Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app making the request can be retrieved.	externalEventId (string) externalAccountId (string) required
marketing_events/put_marketing_v3_marketing_events_events_by_external_event_id	Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.	externalEventId (string) data: { . startDateTime (string) . customProperties (array) . externalAccountId (string) . eventCancelled (boolean) . eventOrganizer (string) . eventUrl (string) . externalEventId (string) . eventDescription (string) . eventName (string) . eventType (string) . eventCompleted (boolean) . endDateTime (string) } (object) required
marketing_events/delete_marketing_v3_marketing_events_events_by_external_event_id	Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app can be deleted.	externalEventId (string) externalAccountId (string) required
marketing_events/patch_marketing_v3_marketing_events_events_by_external_event_id	Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists. Only Marketing Events created by the same app can be updated.	externalEventId (string) externalAccountId (string) required data: { . startDateTime (string) . customProperties (array) . eventCancelled (boolean) . eventOrganizer (string) . eventUrl (string) . eventDescription (string) . eventName (string) . eventType (string) . eventCompleted (boolean) . endDateTime (string) } (object) required
marketing_events/post_marketing_v3_marketing_events_events_upsert	Upserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created. Only Marketing Events originally created by the same app can be updated.	data: { . inputs (array) } (object) required
marketing_events/post_marketing_v3_marketing_events_attendance_by_external_event_id_by_subscriber_state_email_create	Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state 'attend': - joinedAt - leftAt	externalEventId (string) subscriberState (string) externalAccountId (string) data: { . inputs (array) } (object) required
marketing_events/get_marketing_v3_marketing_events_participations_by_external_account_id_by_external_event_id_breakdown	Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.	externalAccountId (string) externalEventId (string) contactIdentifier (string) state (string) limit (integer) after (string)
marketing_events/get_marketing_v3_marketing_events_by_object_id	Returns the details of a Marketing Event with the specified objectId, if it exists.	objectId (string)
marketing_events/delete_marketing_v3_marketing_events_by_object_id	Deletes the existing Marketing Event with the specified objectId, if it exists.	objectId (string)
marketing_events/patch_marketing_v3_marketing_events_by_object_id	Updates the details of an existing Marketing Event identified by its objectId, if it exists.	objectId (string) data: { . startDateTime (string) . customProperties (array) . eventCancelled (boolean) . eventOrganizer (string) . eventUrl (string) . eventDescription (string) . eventName (string) . eventType (string) . endDateTime (string) } (object) required
marketing_events/get_marketing_v3_marketing_events_associations_by_external_account_id_by_external_event_id_lists	Gets lists associated with a marketing event by external account id and external event id	externalAccountId (string) externalEventId (string)
marketing_events/get_marketing_v3_marketing_events_associations_by_marketing_event_id_lists	Gets lists associated with a marketing event by marketing event id	marketingEventId (string)
marketing_events/post_marketing_v3_marketing_events_by_object_id_attendance_by_subscriber_state_email_create	Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state 'attend': - joinedAt - leftAt	objectId (string) subscriberState (string) data: { . inputs (array) } (object) required
marketing_events/get_marketing_v3_marketing_events	Returns all Marketing Events available on the portal, along with their properties, regardless of whether they were created manually or through the application. The marketing events returned by this endpoint are sorted by objectId.	after (string) limit (integer)
marketing_events/post_marketing_v3_marketing_events_batch_update	Updates multiple Marketing Events on the portal based on their objectId, if they exist.	data: { . inputs (array) } (object) required
marketing_events/post_marketing_v3_marketing_events_by_object_id_attendance_by_subscriber_state_create	Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state 'attend': - joinedAt - leftAt	objectId (string) subscriberState (string) data: { . inputs (array) } (object) required
marketing_events/post_marketing_v3_marketing_events_batch_archive	Deletes multiple Marketing Events from the portal based on their objectId, if they exist. Responses: 204: Returned if all specified Marketing Events were successfully deleted. 207: Returned if some objectIds did not correspond to any existing Marketing Events.	data: { . inputs (array) } (object) required
marketing_events/get_marketing_v3_marketing_events_participations_by_external_account_id_by_external_event_id	Read Marketing event's participations counters by externalAccountId and externalEventId pair.	externalAccountId (string) externalEventId (string)
marketing_events/get_marketing_v3_marketing_events_by_external_event_id_identifiers	This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request. It retrieves the objectId and additional event details for each matching Marketing Event. Since multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results. Note: Marketing Events become searchable by externalEventId a few minutes after creation.	externalEventId (string)
marketing_events/get_marketing_v3_marketing_events_participations_by_marketing_event_id	Read Marketing event's participations counters by internal identifier marketingEventId.	marketingEventId (integer)
marketing_events/post_marketing_v3_marketing_events_events_delete	Deletes multiple Marketing Events based on externalAccountId, externalEventId, and appId. Only Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint.	data: { . inputs (array) } (object) required
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_cancel	Mark a marketing event as cancelled.	externalEventId (string) externalAccountId (string) required
marketing_events/put_marketing_v3_marketing_events_associations_by_marketing_event_id_lists_by_list_id	Associates a list with a marketing event by marketing event id and ILS list id	marketingEventId (string) listId (string)
marketing_events/delete_marketing_v3_marketing_events_associations_by_marketing_event_id_lists_by_list_id	Disassociates a list from a marketing event by marketing event id and ILS list id	marketingEventId (string) listId (string)
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_by_subscriber_state_email_upsert	Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts.	externalEventId (string) subscriberState (string) externalAccountId (string) required data: { . inputs (array) } (object) required
marketing_events/put_marketing_v3_marketing_events_associations_by_external_account_id_by_external_event_id_lists_by_list_id	Associates a list with a marketing event by external account id, external event id, and ILS list id	externalAccountId (string) externalEventId (string) listId (string)
marketing_events/delete_marketing_v3_marketing_events_associations_by_external_account_id_by_external_event_id_lists_by_list_id	Disassociates a list from a marketing event by external account id, external event id, and ILS list id	externalAccountId (string) externalEventId (string) listId (string)
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_complete	Mark a marketing event as completed	externalEventId (string) externalAccountId (string) required data: { . startDateTime (string) . endDateTime (string) } (object) required
marketing_events/post_marketing_v3_marketing_events_events	Creates a new marketing event in HubSpot	data: { . startDateTime (string) . customProperties (array) . externalAccountId (string) . eventCancelled (boolean) . eventOrganizer (string) . eventUrl (string) . externalEventId (string) . eventDescription (string) . eventName (string) . eventType (string) . eventCompleted (boolean) . endDateTime (string) } (object) required
marketing_events/get_marketing_v3_marketing_events_participations_contacts_by_contact_identifier_breakdown	Read Contact's participations by identifier - email or internal id.	contactIdentifier (string) state (string) limit (integer) after (string)
marketing_events/get_marketing_v3_marketing_events_by_app_id_settings	Retrieve the current settings for the application.	appId (integer)
marketing_events/post_marketing_v3_marketing_events_by_app_id_settings	Create or update the current settings for the application.	appId (integer) data: { . eventDetailsUrl (string) } (object) required
marketing_events/get_marketing_v3_marketing_events_events_search	Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request. Marketing Events created by other apps will not be included in the results.	q (string) required
media_bridge/get_media_bridge_v1_by_app_id_settings_event_visibility	No description available	appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_settings_event_visibility	No description available	appId (integer) data: { . showInWorkflows (boolean) . showInReporting (boolean) . eventType (string) . showInTimeline (boolean) . updatedAt (integer) } (object) required
media_bridge/get_media_bridge_v1_by_app_id_schemas	No description available	appId (integer) archived (boolean)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_batch_archive	No description available	objectType (string) appId (integer) data: { . inputs (array) } (object) required
media_bridge/post_media_bridge_v1_events_attention_span	No description available	data: { . mediaUrl (string) . contactId (integer) . rawDataString (string) . rawDataMap (object) . derivedValues . externalId (string) . mediaType (string) . sessionId (string) . pageId (integer) . pageName (string) . occurredTimestamp (integer) . contactUtk (string) . pageUrl (string) . _hsenc (string) . mediaBridgeId (integer) . mediaName (string) } (object) required
media_bridge/post_media_bridge_v1_events_media_played_percent	No description available	data: { . mediaUrl (string) . contactId (integer) . externalId (string) . mediaType (string) . sessionId (string) . playedPercent (integer) . pageId (integer) . pageName (string) . occurredTimestamp (integer) . contactUtk (string) . pageUrl (string) . _hsenc (string) . mediaBridgeId (integer) . mediaName (string) } (object) required
media_bridge/post_media_bridge_v1_by_app_id_settings_register	No description available	appId (integer) data: { . name (string) . updatedAt (integer) } (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_type_by_property_name	No description available	objectType (string) propertyName (string) appId (integer) archived (boolean) properties (string)
media_bridge/delete_media_bridge_v1_by_app_id_properties_by_object_type_by_property_name	No description available	objectType (string) propertyName (string) appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_properties_by_object_type_by_property_name	No description available	objectType (string) propertyName (string) appId (integer) data: { . groupName (string) . hidden (boolean) . options (array) . displayOrder (integer) . description (string) . calculationFormula (string) . label (string) . hasUniqueValue (boolean) . type (string) . fieldType (string) . formField (boolean) } (object) required
media_bridge/post_media_bridge_v1_by_app_id_schemas_by_object_type_associations	No description available	objectType (string) appId (integer) data: { . fromObjectTypeId (string) . name (string) . toObjectTypeId (string) } (object) required
media_bridge/get_media_bridge_v1_by_app_id_settings_object_definitions_by_media_type	No description available	mediaType (string) appId (integer) includeFullDefinition (boolean)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_batch_read	No description available	objectType (string) appId (integer) data: { . archived (boolean) . inputs (array) . dataSensitivity (string) } (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_type_groups	No description available	objectType (string) appId (integer)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_groups	No description available	objectType (string) appId (integer) data: { . name (string) . displayOrder (integer) . label (string) } (object) required
media_bridge/get_media_bridge_v1_by_app_id_schemas_by_object_type	No description available	objectType (string) appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_schemas_by_object_type	No description available	objectType (string) appId (integer) data: { . secondaryDisplayProperties (array) . requiredProperties (array) . searchableProperties (array) . clearDescription (boolean) . primaryDisplayProperty (string) . description (string) . allowsSensitiveProperties (boolean) . restorable (boolean) . labels } (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_type_groups_by_group_name	No description available	objectType (string) groupName (string) appId (integer)
media_bridge/delete_media_bridge_v1_by_app_id_properties_by_object_type_groups_by_group_name	No description available	objectType (string) groupName (string) appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_properties_by_object_type_groups_by_group_name	No description available	objectType (string) groupName (string) appId (integer) data: { . displayOrder (integer) . label (string) } (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_type	No description available	objectType (string) appId (integer) archived (boolean) properties (string)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type	No description available	objectType (string) appId (integer) data: { . hidden (boolean) . displayOrder (integer) . description (string) . label (string) . type (string) . formField (boolean) . dataSensitivity (string) . groupName (string) . referencedObjectType (string) . name (string) . options (array) . calculationFormula (string) . hasUniqueValue (boolean) . fieldType (string) . externalOptions (boolean) } (object) required
media_bridge/post_media_bridge_v1_by_app_id_settings_object_definitions	No description available	appId (integer) data: { . mediaTypes (array) } (object) required
media_bridge/get_media_bridge_v1_by_app_id_settings_oembed_domains	No description available	appId (integer) domainPortalId (integer)
media_bridge/post_media_bridge_v1_by_app_id_settings_oembed_domains	No description available	appId (integer) data: { . endpoints . portalId (integer) } (object) required
media_bridge/delete_media_bridge_v1_by_app_id_settings_oembed_domains	No description available	appId (integer) id (integer) domainPortalId (integer)
media_bridge/put_media_bridge_v1_by_app_id_settings	No description available	appId (integer) data: { . name (string) . updatedAt (integer) } (object) required
media_bridge/delete_media_bridge_v1_by_app_id_schemas_by_object_type_associations_by_association_id	No description available	objectType (string) associationId (string) appId (integer)
media_bridge/get_media_bridge_v1_by_app_id_settings_oembed_domains_by_o_embed_domain_id	No description available	oEmbedDomainId (string) appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_settings_oembed_domains_by_o_embed_domain_id	No description available	oEmbedDomainId (string) appId (integer) data: { . endpoints . portalId (integer) } (object) required
media_bridge/post_media_bridge_v1_events_media_played	No description available	data: { . mediaUrl (string) . contactId (integer) . externalId (string) . mediaType (string) . sessionId (string) . pageId (integer) . pageName (string) . iframeUrl (string) . occurredTimestamp (integer) . contactUtk (string) . pageUrl (string) . state (string) . _hsenc (string) . mediaBridgeId (integer) . mediaName (string) } (object) required
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_batch_create	No description available	objectType (string) appId (integer) data: { . inputs (array) } (object) required
meetings/get_scheduler_v3_meetings_meeting_links_book_by_slug	No description available	slug (string) timezone (string)
meetings/get_scheduler_v3_meetings_meeting_links	No description available	after (string) limit (integer) name (string) organizerUserId (string) type (string)
meetings/post_scheduler_v3_meetings_meeting_links_book	No description available	data: { . duration (integer) . firstName (string) . lastName (string) . likelyAvailableUserIds (array) . timezone (string) . legalConsentResponses (array) . startTime (string) . formFields (array) . locale (string) . slug (string) . email (string) } (object) required
meetings/get_scheduler_v3_meetings_meeting_links_book_availability_page_by_slug	No description available	slug (string) timezone (string) monthOffset (integer)
multicurrency/get_settings_v3_currencies_exchange_rates	No description available	limit (integer) after (string) fromCurrencyCode (string) toCurrencyCode (string)
multicurrency/post_settings_v3_currencies_exchange_rates	No description available	data: { . effectiveAt (string) . conversionRate (number) . fromCurrencyCode (string) } (object) required
multicurrency/get_settings_v3_currencies_codes	No description available	No parameters
multicurrency/get_settings_v3_currencies_company_currency	No description available	No parameters
multicurrency/put_settings_v3_currencies_company_currency	No description available	data: { . currencyCode (string) } (object) required
multicurrency/post_settings_v3_currencies_exchange_rates_batch_update	No description available	data: { . inputs (array) } (object) required
multicurrency/get_settings_v3_currencies_exchange_rates_current	No description available	No parameters
multicurrency/post_settings_v3_currencies_exchange_rates_update_visibility	No description available	data: { . toCurrencyCode (string) . visibleInUI (boolean) . fromCurrencyCode (string) } (object) required
multicurrency/get_settings_v3_currencies_exchange_rates_by_exchange_rate_id	No description available	exchangeRateId (string)
multicurrency/patch_settings_v3_currencies_exchange_rates_by_exchange_rate_id	No description available	exchangeRateId (string) data: { . effectiveAt (string) . conversionRate (number) } (object) required
multicurrency/post_settings_v3_currencies_exchange_rates_batch_create	No description available	data: { . inputs (array) } (object) required
multicurrency/post_settings_v3_currencies_exchange_rates_batch_read	No description available	data: { . inputs (array) } (object) required
notes/post_crm_v3_objects_notes_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
notes/get_crm_v3_objects_notes_by_note_id	Read an Object identified by noteId. noteId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	noteId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
notes/delete_crm_v3_objects_notes_by_note_id	Move an Object identified by noteId to the recycling bin.	noteId (string)
notes/patch_crm_v3_objects_notes_by_note_id	Perform a partial update of an Object identified by noteIdor optionally a unique property value as specified by the idProperty query param. noteId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	noteId (string) idProperty (string) data: { . properties (object) } (object) required
notes/post_crm_v3_objects_notes_batch_archive	Archive a batch of notes by ID	data: { . inputs (array) } (object) required
notes/post_crm_v3_objects_notes_batch_create	Create a batch of notes	data: { . inputs (array) } (object) required
notes/post_crm_v3_objects_notes_batch_update	Update a batch of notes by internal ID, or unique property values	data: { . inputs (array) } (object) required
notes/get_crm_v3_objects_notes	Read a page of notes. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
notes/post_crm_v3_objects_notes	Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.	data: { . associations (array) . properties (object) } (object) required
notes/post_crm_v3_objects_notes_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
notes/post_crm_v3_objects_notes_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
oauth/get_oauth_v1_access_tokens_by_token	Retrieve a token's metadata, including the email address of the user that the token was created for and the ID of the account it's associated with. Note: HubSpot access tokens will fluctuate in size as the information that's encoded in them changes over time. It's recommended to allow for tokens to be up to 300 characters to account for any potential changes.	token (string)
oauth/get_oauth_v1_refresh_tokens_by_token	Retrieve a refresh token's metadata, including the email address of the user that the token was created for and the ID of the account it's associated with. Learn more about refresh tokenshttps://developers.hubspot.com/docs/guides/api/app-management/oauth-tokens generate-initial-access-and-refresh-tokens.	token (string)
oauth/delete_oauth_v1_refresh_tokens_by_token	Delete a refresh token, typically after a user uninstalls your app. Access tokens generated with the refresh token will not be affected. This will not uninstall the application from HubSpot or inhibit data syncing between an account and the app.	token (string)
oauth/post_oauth_v1_token	Use a previously obtained refresh token get-oauth-2.0-access-and-refresh-tokens to generate a new access token. Access tokens are short lived. You can check the expires_in parameter when generating an access token to determine its lifetime in seconds. If you need offline access to HubSpot data, store the refresh token you get when initiating your OAuth integrationhttps://developers.hubspot.com/docs/guides/api/app-management/oauth-tokens initiating-oauth-access and use it to generate a new acce	No parameters
object_library/get_crm_v3_object_library_enablement	Returns all objects in the object library and their enablement status	No parameters
object_library/get_crm_v3_object_library_enablement_by_object_type_id	Returns an object and its enablement status	objectTypeId (string)
objects/post_crm_v3_objects_by_object_type_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	objectType (string) archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
objects/get_crm_v3_objects_by_object_type_by_object_id	Read an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	objectType (string) objectId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
objects/delete_crm_v3_objects_by_object_type_by_object_id	Move an Object identified by objectId to the recycling bin.	objectType (string) objectId (string)
objects/patch_crm_v3_objects_by_object_type_by_object_id	Perform a partial update of an Object identified by objectIdor optionally a unique property value as specified by the idProperty query param. objectId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	objectType (string) objectId (string) idProperty (string) data: { . properties (object) } (object) required
objects/post_crm_v3_objects_by_object_type_batch_archive	Archive a batch of objects by ID	objectType (string) data: { . inputs (array) } (object) required
objects/post_crm_v3_objects_by_object_type_batch_create	Create a batch of objects	objectType (string) data: { . inputs (array) } (object) required
objects/post_crm_v3_objects_by_object_type_batch_update	Update a batch of objects by internal ID, or unique property values	objectType (string) data: { . inputs (array) } (object) required
objects/get_crm_v3_objects_by_object_type	Read a page of objects. Control what is returned via the properties query param.	objectType (string) limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
objects/post_crm_v3_objects_by_object_type	Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.	objectType (string) data: { . associations (array) . properties (object) } (object) required
objects/post_crm_v3_objects_by_object_type_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	objectType (string) data: { . inputs (array) } (object) required
objects/post_crm_v3_objects_by_object_type_search	No description available	objectType (string) data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
orders/post_crm_v3_objects_orders_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
orders/get_crm_v3_objects_orders_by_order_id	Read an Object identified by orderId. orderId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	orderId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
orders/delete_crm_v3_objects_orders_by_order_id	Move an Object identified by orderId to the recycling bin.	orderId (string)
orders/patch_crm_v3_objects_orders_by_order_id	Perform a partial update of an Object identified by orderIdor optionally a unique property value as specified by the idProperty query param. orderId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	orderId (string) idProperty (string) data: { . properties (object) } (object) required
orders/post_crm_v3_objects_orders_batch_archive	Archive a batch of orders by ID	data: { . inputs (array) } (object) required
orders/post_crm_v3_objects_orders_batch_create	Create a batch of orders	data: { . inputs (array) } (object) required
orders/post_crm_v3_objects_orders_batch_update	Update a batch of orders by internal ID, or unique property values	data: { . inputs (array) } (object) required
orders/get_crm_v3_objects_orders	Read a page of orders. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
orders/post_crm_v3_objects_orders	Create a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided.	data: { . associations (array) . properties (object) } (object) required
orders/post_crm_v3_objects_orders_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
orders/post_crm_v3_objects_orders_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
pages/get_cms_v3_pages_site_pages_by_object_id_revisions_by_revision_id	Retrieves a previous version of a Site Page	objectId (string) revisionId (string)
pages/get_cms_v3_pages_landing_pages_by_object_id_revisions	Retrieves all the previous versions of a Landing Page.	objectId (string) after (string) before (string) limit (integer)
pages/post_cms_v3_pages_site_pages_batch_update	Update the Site Page objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
pages/get_cms_v3_pages_landing_pages_folders_by_object_id_revisions	Retrieves all the previous versions of a Folder.	objectId (string) after (string) before (string) limit (integer)
pages/post_cms_v3_pages_site_pages_by_object_id_revisions_by_revision_id_restore	Takes a specified version of a Site Page and restores it.	objectId (string) revisionId (string)
pages/get_cms_v3_pages_landing_pages_folders	Get the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean) property (string)
pages/post_cms_v3_pages_landing_pages_folders	Create a new Folder	data: { . deletedAt (string) . parentFolderId (integer) . created (string) . name (string) . id (string) . category (integer) . updated (string) } (object) required
pages/post_cms_v3_pages_site_pages_multi_language_attach_to_lang_group	Attach a site page to a multi-language group.	data: { . language (string) . id (string) . primaryId (string) . primaryLanguage (string) } (object) required
pages/post_cms_v3_pages_site_pages_schedule	Schedule a Site Page to be Published	data: { . publishDate (string) . id (string) } (object) required
pages/post_cms_v3_pages_site_pages_multi_language_detach_from_lang_group	Detach a site page from a multi-language group.	data: { . id (string) } (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_create	Create the Folder objects detailed in the request body.	data: { . inputs (array) } (object) required
pages/get_cms_v3_pages_site_pages_by_object_id_revisions	Retrieves all the previous versions of a Site Page.	objectId (string) after (string) before (string) limit (integer)
pages/get_cms_v3_pages_landing_pages_by_object_id_draft	Retrieve the full draft version of the Landing Page.	objectId (string)
pages/patch_cms_v3_pages_landing_pages_by_object_id_draft	Sparse updates the draft version of a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying.	objectId (string) data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . publishImmediately (boolean) . htmlTitle (string) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . subcategory (string) . layoutSections (object) . updated (string) . footerHtml (string) . widgets (object) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . contentGroupId (string) . pageExpiryEnabled (boolean) . templatePath (string) . url (string) . publicAccessRules (array) . archivedAt (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . pageRedirected (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
pages/get_cms_v3_pages_landing_pages	Get the list of landing pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean) property (string)
pages/post_cms_v3_pages_landing_pages	Create a new Landing Page	data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . publishImmediately (boolean) . htmlTitle (string) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . subcategory (string) . layoutSections (object) . updated (string) . footerHtml (string) . widgets (object) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . contentGroupId (string) . pageExpiryEnabled (boolean) . templatePath (string) . url (string) . publicAccessRules (array) . archivedAt (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . pageRedirected (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
pages/post_cms_v3_pages_site_pages_ab_test_end	End an active A/B test and designate a winner.	data: { . winnerId (string) . abTestId (string) } (object) required
pages/post_cms_v3_pages_site_pages_by_object_id_revisions_by_revision_id_restore_to_draft	Takes a specified version of a Site Page, sets it as the new draft version of the Site Page.	objectId (string) revisionId (integer)
pages/post_cms_v3_pages_landing_pages_batch_create	Create the Landing Page objects detailed in the request body.	data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_landing_pages_batch_update	Update the Landing Page objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_landing_pages_batch_read	Retrieve the Landing Page objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_landing_pages_clone	Clone a Landing Page	data: { . cloneName (string) . id (string) } (object) required
pages/post_cms_v3_pages_landing_pages_folders_by_object_id_revisions_by_revision_id_restore	Takes a specified version of a Folder and restores it.	objectId (string) revisionId (string)
pages/put_cms_v3_pages_landing_pages_multi_language_set_new_lang_primary	Set a landing page as the primary language of a multi-language group.	data: { . id (string) } (object) required
pages/post_cms_v3_pages_landing_pages_by_object_id_revisions_by_revision_id_restore	Takes a specified version of a Landing Page and restores it.	objectId (string) revisionId (string)
pages/get_cms_v3_pages_site_pages_by_object_id_draft	Retrieve the full draft version of the Site Page.	objectId (string)
pages/patch_cms_v3_pages_site_pages_by_object_id_draft	Sparse updates the draft version of a single Site Page object identified by the id in the path. You only need to specify the column values that you are modifying.	objectId (string) data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . publishImmediately (boolean) . htmlTitle (string) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . subcategory (string) . layoutSections (object) . updated (string) . footerHtml (string) . widgets (object) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . contentGroupId (string) . pageExpiryEnabled (boolean) . templatePath (string) . url (string) . publicAccessRules (array) . archivedAt (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . pageRedirected (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
pages/get_cms_v3_pages_landing_pages_folders_by_object_id	Retrieve the Folder object identified by the id in the path.	objectId (string) archived (boolean) property (string)
pages/delete_cms_v3_pages_landing_pages_folders_by_object_id	Delete the Folder object identified by the id in the path.	objectId (string) archived (boolean)
pages/patch_cms_v3_pages_landing_pages_folders_by_object_id	Sparse updates a single Folder object identified by the id in the path. You only need to specify the column values that you are modifying.	objectId (string) archived (boolean) data: { . deletedAt (string) . parentFolderId (integer) . created (string) . name (string) . id (string) . category (integer) . updated (string) } (object) required
pages/post_cms_v3_pages_site_pages_batch_read	Retrieve the Site Page objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_landing_pages_ab_test_create_variation	Create a new A/B test variation based on the information provided in the request body.	data: { . variationName (string) . contentId (string) } (object) required
pages/post_cms_v3_pages_landing_pages_multi_language_attach_to_lang_group	Attach a landing page to a multi-language group.	data: { . language (string) . id (string) . primaryId (string) . primaryLanguage (string) } (object) required
pages/get_cms_v3_pages_site_pages	Get the list of site pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean) property (string)
pages/post_cms_v3_pages_site_pages	Create a new Site Page	data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . publishImmediately (boolean) . htmlTitle (string) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . subcategory (string) . layoutSections (object) . updated (string) . footerHtml (string) . widgets (object) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . contentGroupId (string) . pageExpiryEnabled (boolean) . templatePath (string) . url (string) . publicAccessRules (array) . archivedAt (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . pageRedirected (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
pages/get_cms_v3_pages_landing_pages_by_object_id_revisions_by_revision_id	Retrieves a previous version of a Landing Page	objectId (string) revisionId (string)
pages/post_cms_v3_pages_site_pages_multi_language_create_language_variation	Create a new language variation from an existing site page	data: { . language (string) . id (string) . primaryLanguage (string) } (object) required
pages/post_cms_v3_pages_landing_pages_ab_test_end	End an active A/B test and designate a winner.	data: { . winnerId (string) . abTestId (string) } (object) required
pages/post_cms_v3_pages_landing_pages_by_object_id_draft_push_live	Take any changes from the draft version of the Landing Page and apply them to the live version.	objectId (string)
pages/post_cms_v3_pages_landing_pages_multi_language_detach_from_lang_group	Detach a landing page from a multi-language group.	data: { . id (string) } (object) required
pages/post_cms_v3_pages_landing_pages_multi_language_update_languages	Explicitly set new languages for each landing page in a multi-language group.	data: { . languages (object) . primaryId (string) } (object) required
pages/post_cms_v3_pages_landing_pages_schedule	Schedule a Landing Page to be Published	data: { . publishDate (string) . id (string) } (object) required
pages/post_cms_v3_pages_site_pages_ab_test_create_variation	Create a new A/B test variation based on the information provided in the request body.	data: { . variationName (string) . contentId (string) } (object) required
pages/post_cms_v3_pages_site_pages_multi_language_update_languages	Explicitly set new languages for each site page in a multi-language group.	data: { . languages (object) . primaryId (string) } (object) required
pages/post_cms_v3_pages_landing_pages_ab_test_rerun	Rerun a previous A/B test.	data: { . variationId (string) . abTestId (string) } (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_archive	Delete the Folder objects identified in the request body.	data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_site_pages_batch_archive	Delete the Site Page objects identified in the request body. Note: This is not the same as the dashboard archive function. To perform a dashboard archive send an normal update with the archivedInDashboard field set to true.	data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_site_pages_batch_create	Create the Site Page objects detailed in the request body.	data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_update	Update the Folder objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_site_pages_clone	Clone a Site Page	data: { . cloneName (string) . id (string) } (object) required
pages/put_cms_v3_pages_site_pages_multi_language_set_new_lang_primary	Set a site page as the primary language of a multi-language group.	data: { . id (string) } (object) required
pages/get_cms_v3_pages_landing_pages_folders_by_object_id_revisions_by_revision_id	Retrieves a previous version of a Folder	objectId (string) revisionId (string)
pages/post_cms_v3_pages_landing_pages_by_object_id_draft_reset	Discards any edits and resets the draft to the live version.	objectId (string)
pages/get_cms_v3_pages_landing_pages_by_object_id	Retrieve the Landing Page object identified by the id in the path.	objectId (string) archived (boolean) property (string)
pages/delete_cms_v3_pages_landing_pages_by_object_id	Delete the Landing Page object identified by the id in the path.	objectId (string) archived (boolean)
pages/patch_cms_v3_pages_landing_pages_by_object_id	Sparse updates a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying.	objectId (string) archived (boolean) data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . publishImmediately (boolean) . htmlTitle (string) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . subcategory (string) . layoutSections (object) . updated (string) . footerHtml (string) . widgets (object) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . contentGroupId (string) . pageExpiryEnabled (boolean) . templatePath (string) . url (string) . publicAccessRules (array) . archivedAt (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . pageRedirected (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
pages/post_cms_v3_pages_landing_pages_multi_language_create_language_variation	Create a new language variation from an existing landing page	data: { . language (string) . id (string) . primaryLanguage (string) } (object) required
pages/post_cms_v3_pages_site_pages_by_object_id_draft_push_live	Take any changes from the draft version of the Site Page and apply them to the live version.	objectId (string)
pages/post_cms_v3_pages_landing_pages_batch_archive	Delete the Landing Page objects identified in the request body. Note: This is not the same as the dashboard archive function. To perform a dashboard archive send an normal update with the archivedInDashboard field set to true.	data: { . inputs (array) } (object) required
pages/post_cms_v3_pages_landing_pages_by_object_id_revisions_by_revision_id_restore_to_draft	Takes a specified version of a Landing Page, sets it as the new draft version of the Landing Page.	objectId (string) revisionId (integer)
pages/post_cms_v3_pages_site_pages_ab_test_rerun	Rerun a previous A/B test.	data: { . variationId (string) . abTestId (string) } (object) required
pages/post_cms_v3_pages_site_pages_by_object_id_draft_reset	Discards any edits and resets the draft to the live version.	objectId (string)
pages/get_cms_v3_pages_site_pages_by_object_id	Retrieve the Site Page object identified by the id in the path.	objectId (string) archived (boolean) property (string)
pages/delete_cms_v3_pages_site_pages_by_object_id	Delete the Site Page object identified by the id in the path.	objectId (string) archived (boolean)
pages/patch_cms_v3_pages_site_pages_by_object_id	Sparse updates a single Site Page object identified by the id in the path. You only need to specify the column values that you are modifying.	objectId (string) archived (boolean) data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . publishImmediately (boolean) . htmlTitle (string) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . subcategory (string) . layoutSections (object) . updated (string) . footerHtml (string) . widgets (object) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . contentGroupId (string) . pageExpiryEnabled (boolean) . templatePath (string) . url (string) . publicAccessRules (array) . archivedAt (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . pageRedirected (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_read	Update the Folder objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
partner_clients/post_crm_v3_objects_partner_clients_batch_read	Retrieve a batch of partner clients by ID partnerClientId or unique property value idProperty.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
partner_clients/get_crm_v3_objects_partner_clients_by_partner_client_id	Retrieve a partner client by its ID partnerClientId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	partnerClientId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
partner_clients/patch_crm_v3_objects_partner_clients_by_partner_client_id	Update a partner client by ID partnerClientId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	partnerClientId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
partner_clients/post_crm_v3_objects_partner_clients_batch_update	Update a batch of partner clients by ID partnerClientId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	data: { . inputs (array) } (object) required
partner_clients/get_crm_v3_objects_partner_clients	Retrieve all partner clients, using query parameters to specify the information that gets returned.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
partner_clients/post_crm_v3_objects_partner_clients_search	Search for partner clients by filtering on properties, searching through associations, and sorting results. Learn more about CRM searchhttps://developers.hubspot.com/docs/guides/api/crm/search make-a-search-request.	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
payments/post_crm_v3_objects_payments_batch_read	Read a batch of payments by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
payments/get_crm_v3_objects_payments_by_payments_id	Read an Object identified by paymentsId. paymentsId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	paymentsId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
payments/get_crm_v3_objects_payments	Read a page of payments. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
payments/post_crm_v3_objects_payments_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_id_audit	Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by stageId.	objectType (string) stageId (string) pipelineId (string)
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id	Return a single pipeline object identified by its unique pipelineId.	objectType (string) pipelineId (string)
pipelines/put_crm_v3_pipelines_by_object_type_by_pipeline_id	Replace all the properties of an existing pipeline with the values provided. This will overwrite any existing pipeline stages. The updated pipeline will be returned in the response.	objectType (string) pipelineId (string) validateReferencesBeforeDelete (boolean) validateDealStageUsagesBeforeDelete (boolean) data: { . displayOrder (integer) . stages (array) . label (string) } (object) required
pipelines/delete_crm_v3_pipelines_by_object_type_by_pipeline_id	Delete the pipeline identified by pipelineId.	objectType (string) pipelineId (string) validateReferencesBeforeDelete (boolean) validateDealStageUsagesBeforeDelete (boolean)
pipelines/patch_crm_v3_pipelines_by_object_type_by_pipeline_id	Perform a partial update of the pipeline identified by pipelineId. The updated pipeline will be returned in the response.	objectType (string) pipelineId (string) validateReferencesBeforeDelete (boolean) validateDealStageUsagesBeforeDelete (boolean) data: { . archived (boolean) . displayOrder (integer) . label (string) } (object) required
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_audit	Return a reverse chronological list of all mutations that have occurred on the pipeline identified by pipelineId.	objectType (string) pipelineId (string)
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_stages	Return all the stages associated with the pipeline identified by pipelineId.	objectType (string) pipelineId (string)
pipelines/post_crm_v3_pipelines_by_object_type_by_pipeline_id_stages	Create a new stage associated with the pipeline identified by pipelineId. The entire stage object, including its unique ID, will be returned in the response.	objectType (string) pipelineId (string) data: { . metadata (object) . displayOrder (integer) . label (string) } (object) required
pipelines/get_crm_v3_pipelines_by_object_type	Return all pipelines for the object type specified by objectType.	objectType (string)
pipelines/post_crm_v3_pipelines_by_object_type	Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.	objectType (string) data: { . displayOrder (integer) . stages (array) . label (string) } (object) required
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_id	Return the stage identified by stageId associated with the pipeline identified by pipelineId.	objectType (string) pipelineId (string) stageId (string)
pipelines/put_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_id	Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.	objectType (string) pipelineId (string) stageId (string) data: { . metadata (object) . displayOrder (integer) . label (string) } (object) required
pipelines/delete_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_id	Delete the pipeline stage identified by stageId associated with the pipeline identified by pipelineId.	objectType (string) pipelineId (string) stageId (string)
pipelines/patch_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_id	Perform a partial update of the pipeline stage identified by stageId associated with the pipeline identified by pipelineId. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response.	objectType (string) pipelineId (string) stageId (string) data: { . archived (boolean) . metadata (object) . displayOrder (integer) . label (string) } (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_read	Read a batch of postal mail by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
postal_mail/get_crm_v3_objects_postal_mail_by_postal_mail_id	Read an Object identified by postalMailId. postalMailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	postalMailId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
postal_mail/delete_crm_v3_objects_postal_mail_by_postal_mail_id	Move an Object identified by postalMailId to the recycling bin.	postalMailId (string)
postal_mail/patch_crm_v3_objects_postal_mail_by_postal_mail_id	Perform a partial update of an Object identified by postalMailId. postalMailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.	postalMailId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_archive	Archive a batch of postal mail by ID	data: { . inputs (array) } (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_create	Create a batch of postal mail	data: { . inputs (array) } (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_update	Update a batch of postal mail by internal ID, or unique property values	data: { . inputs (array) } (object) required
postal_mail/get_crm_v3_objects_postal_mail	Read a page of postal mail. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
postal_mail/post_crm_v3_objects_postal_mail	Create a postal mail with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard postal mail is provided.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
postal_mail/post_crm_v3_objects_postal_mail_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
posts/post_cms_v3_blogs_posts_schedule	Schedule a blog post to be published at a specified time.	data: { . publishDate (string) . id (string) } (object) required
posts/post_cms_v3_blogs_posts_batch_read	Retrieve a batch of blog posts by ID. identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
posts/post_cms_v3_blogs_posts_multi_language_update_languages	Explicitly set new languages for each post in a multi-language grouphttps://developers.hubspot.com/docs/guides/cms/content/multi-language-content.	data: { . languages (object) . primaryId (string) } (object) required
posts/post_cms_v3_blogs_posts_batch_create	Create a batch of blog posts, specifying their content in the request body.	data: { . inputs (array) } (object) required
posts/post_cms_v3_blogs_posts_batch_update	Update a batch of blog posts.	archived (boolean) data: { . inputs (array) } (object) required
posts/get_cms_v3_blogs_posts_by_object_id_draft	Retrieve the full draft version of a blog post.	objectId (string)
posts/patch_cms_v3_blogs_posts_by_object_id_draft	Partially updates the draft version of a single blog post by ID. You only need to specify the values that you want to update.	objectId (string) data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . htmlTitle (string) . publishImmediately (boolean) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . rssBody (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . layoutSections (object) . updated (string) . footerHtml (string) . tagIds (array) . widgets (object) . postSummary (string) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . blogAuthorId (string) . contentGroupId (string) . rssSummary (string) . pageExpiryEnabled (boolean) . url (string) . enableGoogleAmpOutputOverride (boolean) . publicAccessRules (array) . archivedAt (integer) . postBody (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
posts/get_cms_v3_blogs_posts_by_object_id_revisions_by_revision_id	Retrieve a previous version of a blog post.	objectId (string) revisionId (string)
posts/post_cms_v3_blogs_posts_by_object_id_revisions_by_revision_id_restore_to_draft	Takes a specified version of a blog post, sets it as the new draft version of the blog post.	objectId (string) revisionId (integer)
posts/post_cms_v3_blogs_posts_multi_language_create_language_variation	Create a new language variation from an existing blog post	data: { . language (string) . id (string) } (object) required
posts/get_cms_v3_blogs_posts	Retrieve all blog posts, with paging and filtering options. This method would be useful for an integration that ingests posts and suggests edits.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean) property (string)
posts/post_cms_v3_blogs_posts	Create a new blog post, specifying its content in the request body.	data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . htmlTitle (string) . publishImmediately (boolean) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . rssBody (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . layoutSections (object) . updated (string) . footerHtml (string) . tagIds (array) . widgets (object) . postSummary (string) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . blogAuthorId (string) . contentGroupId (string) . rssSummary (string) . pageExpiryEnabled (boolean) . url (string) . enableGoogleAmpOutputOverride (boolean) . publicAccessRules (array) . archivedAt (integer) . postBody (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
posts/post_cms_v3_blogs_posts_clone	Clone a blog post, making a copy of it in a new blog post.	data: { . cloneName (string) . id (string) } (object) required
posts/post_cms_v3_blogs_posts_by_object_id_revisions_by_revision_id_restore	Restores a blog post to one of its previous versions.	objectId (string) revisionId (string)
posts/post_cms_v3_blogs_posts_multi_language_detach_from_lang_group	Detach a blog post from a multi-language grouphttps://developers.hubspot.com/docs/guides/cms/content/multi-language-content.	data: { . id (string) } (object) required
posts/post_cms_v3_blogs_posts_by_object_id_draft_push_live	Publish the draft version of the blog post, sending its content to the live page.	objectId (string)
posts/post_cms_v3_blogs_posts_batch_archive	Delete a blog post by ID. Note: This is not the same as the in-app archive function. To perform a dashboard archive send an normal update with the archivedInDashboard field set to true.	data: { . inputs (array) } (object) required
posts/post_cms_v3_blogs_posts_by_object_id_draft_reset	Discard all drafted content, resetting the draft to contain the content in the currently published version.	objectId (string)
posts/post_cms_v3_blogs_posts_multi_language_attach_to_lang_group	Attach a blog post to a multi-language grouphttps://developers.hubspot.com/docs/guides/cms/content/multi-language-content.	data: { . language (string) . id (string) . primaryId (string) . primaryLanguage (string) } (object) required
posts/put_cms_v3_blogs_posts_multi_language_set_new_lang_primary	Set the primary language of a multi-language grouphttps://developers.hubspot.com/docs/guides/cms/content/multi-language-content to the language of the provided post specified as an ID in the request body	data: { . id (string) } (object) required
posts/get_cms_v3_blogs_posts_by_object_id	Retrieve a blog post by the post ID.	objectId (string) archived (boolean) property (string)
posts/delete_cms_v3_blogs_posts_by_object_id	Delete a blog post by ID.	objectId (string) archived (boolean)
posts/patch_cms_v3_blogs_posts_by_object_id	Partially updates a single blog post by ID. You only need to specify the values that you want to update.	objectId (string) archived (boolean) data: { . publishDate (string) . language (string) . enableLayoutStylesheets (boolean) . metaDescription (string) . attachedStylesheets (array) . password (string) . htmlTitle (string) . publishImmediately (boolean) . translations (object) . id (string) . state (string) . slug (string) . createdById (string) . rssBody (string) . currentlyPublished (boolean) . archivedInDashboard (boolean) . created (string) . contentTypeCategory (string) . mabExperimentId (string) . updatedById (string) . translatedFromId (string) . folderId (string) . widgetContainers (object) . pageExpiryRedirectId (integer) . dynamicPageDataSourceType (integer) . featuredImage (string) . authorName (string) . domain (string) . name (string) . dynamicPageHubDbTableId (string) . campaign (string) . dynamicPageDataSourceId (string) . enableDomainStylesheets (boolean) . includeDefaultCustomCss (boolean) . layoutSections (object) . updated (string) . footerHtml (string) . tagIds (array) . widgets (object) . postSummary (string) . headHtml (string) . pageExpiryRedirectUrl (string) . abStatus (string) . useFeaturedImage (boolean) . abTestId (string) . featuredImageAltText (string) . blogAuthorId (string) . contentGroupId (string) . rssSummary (string) . pageExpiryEnabled (boolean) . url (string) . enableGoogleAmpOutputOverride (boolean) . publicAccessRules (array) . archivedAt (integer) . postBody (string) . themeSettingsValues (object) . pageExpiryDate (integer) . publicAccessRulesEnabled (boolean) . currentState (string) . categoryId (integer) . linkRelCanonicalUrl (string) } (object) required
posts/get_cms_v3_blogs_posts_by_object_id_revisions	Retrieve all the previous versions of a blog post.	objectId (string) after (string) before (string) limit (integer)
products/post_crm_v3_objects_products_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
products/get_crm_v3_objects_products_by_product_id	Read an Object identified by productId. productId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	productId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
products/delete_crm_v3_objects_products_by_product_id	Move an Object identified by productId to the recycling bin.	productId (string)
products/patch_crm_v3_objects_products_by_product_id	Perform a partial update of an Object identified by productIdor optionally a unique property value as specified by the idProperty query param. productId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	productId (string) idProperty (string) data: { . properties (object) } (object) required
products/post_crm_v3_objects_products_batch_archive	Archive a batch of products by ID	data: { . inputs (array) } (object) required
products/post_crm_v3_objects_products_batch_create	Create a batch of products	data: { . inputs (array) } (object) required
products/post_crm_v3_objects_products_batch_update	Update a batch of products by internal ID, or unique property values	data: { . inputs (array) } (object) required
products/get_crm_v3_objects_products	Read a page of products. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
products/post_crm_v3_objects_products	Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.	data: { . associations (array) . properties (object) } (object) required
products/post_crm_v3_objects_products_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
products/post_crm_v3_objects_products_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
properties/post_crm_v3_properties_by_object_type_batch_archive	Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property e.g. active, already archived, non-existent.	objectType (string) data: { . inputs (array) } (object) required
properties/get_crm_v3_properties_by_object_type_groups_by_group_name	Read a property group identified by groupName.	objectType (string) groupName (string)
properties/delete_crm_v3_properties_by_object_type_groups_by_group_name	Move a property group identified by groupName to the recycling bin.	objectType (string) groupName (string)
properties/patch_crm_v3_properties_by_object_type_groups_by_group_name	Perform a partial update of a property group identified by groupName. Provided fields will be overwritten.	objectType (string) groupName (string) data: { . displayOrder (integer) . label (string) } (object) required
properties/get_crm_v3_properties_by_object_type_by_property_name	Read a property identified by propertyName.	objectType (string) propertyName (string) archived (boolean) properties (string)
properties/delete_crm_v3_properties_by_object_type_by_property_name	Move a property identified by propertyName to the recycling bin.	objectType (string) propertyName (string)
properties/patch_crm_v3_properties_by_object_type_by_property_name	Perform a partial update of a property identified by propertyName. Provided fields will be overwritten.	objectType (string) propertyName (string) data: { . groupName (string) . hidden (boolean) . options (array) . displayOrder (integer) . description (string) . calculationFormula (string) . label (string) . type (string) . fieldType (string) . formField (boolean) } (object) required
properties/post_crm_v3_properties_by_object_type_batch_read	Read a provided list of properties.	objectType (string) data: { . archived (boolean) . inputs (array) } (object) required
properties/post_crm_v3_properties_by_object_type_batch_create	Create a batch of properties using the same rules as when creating an individual property.	objectType (string) data: { . inputs (array) } (object) required
properties/get_crm_v3_properties_by_object_type	Read all existing properties for the specified object type and HubSpot account.	objectType (string) archived (boolean) properties (string)
properties/post_crm_v3_properties_by_object_type	Create and return a copy of a new property for the specified object type.	objectType (string) data: { . hidden (boolean) . displayOrder (integer) . description (string) . label (string) . type (string) . formField (boolean) . groupName (string) . referencedObjectType (string) . name (string) . options (array) . calculationFormula (string) . hasUniqueValue (boolean) . fieldType (string) . externalOptions (boolean) } (object) required
properties/get_crm_v3_properties_by_object_type_groups	Read all existing property groups for the specified object type and HubSpot account.	objectType (string)
properties/post_crm_v3_properties_by_object_type_groups	Create and return a copy of a new property group.	objectType (string) data: { . name (string) . displayOrder (integer) . label (string) } (object) required
property_validations/get_crm_v3_property_validations_by_object_type_id	Read all properties with validation rules for a given object.	objectTypeId (string)
property_validations/get_crm_v3_property_validations_by_object_type_id_by_property_name	Read a property's validation rules identified by propertyName.	objectTypeId (string) propertyName (string)
public_app_crm_cards/get_crm_v3_extensions_cards_dev_sample_response	Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.	No parameters
public_app_crm_cards/get_crm_v3_extensions_cards_dev_by_app_id	Returns a list of cards for a given app.	appId (integer)
public_app_crm_cards/post_crm_v3_extensions_cards_dev_by_app_id	Defines a new card that will become active on an account when this app is installed.	appId (integer) data: { . fetch . display . title (string) . actions } (object) required
public_app_crm_cards/get_crm_v3_extensions_cards_dev_by_app_id_by_card_id	Returns the definition for a card with the given ID.	cardId (string) appId (integer)
public_app_crm_cards/delete_crm_v3_extensions_cards_dev_by_app_id_by_card_id	Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.	cardId (string) appId (integer)
public_app_crm_cards/patch_crm_v3_extensions_cards_dev_by_app_id_by_card_id	Update a card definition with new details.	cardId (string) appId (integer) data: { . fetch . display . title (string) . actions } (object) required
public_app_feature_flags_v3/post_feature_flags_v3_by_app_id_flags_by_flag_name_portals_batch_upsert	Set the portal flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.	flagName (string) appId (integer) data: { . portalStates (array) } (object) required
public_app_feature_flags_v3/get_feature_flags_v3_by_app_id_flags_by_flag_name_portals	Retrieve a list of HubSpot accounts with an account-level flag setting for the specified app. No request body is included.	flagName (string) appId (integer) startPortalId (integer) limit (integer)
public_app_feature_flags_v3/get_feature_flags_v3_by_app_id_flags_by_flag_name_portals_by_portal_id	Retrieve the account-level flag state of a specific HubSpot account.	flagName (string) portalId (integer) appId (integer)
public_app_feature_flags_v3/put_feature_flags_v3_by_app_id_flags_by_flag_name_portals_by_portal_id	Specify an account-level flag state for a specific HubSpot account.	flagName (string) portalId (integer) appId (integer) data: { . flagState (string) } (object) required
public_app_feature_flags_v3/delete_feature_flags_v3_by_app_id_flags_by_flag_name_portals_by_portal_id	Delete an account-level flag state for a specific HubSpot account. No request body is included.	flagName (string) portalId (integer) appId (integer)
public_app_feature_flags_v3/post_feature_flags_v3_by_app_id_flags_by_flag_name_portals_batch_delete	Delete an account-level flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.	flagName (string) appId (integer) data: { . portalIds (array) } (object) required
public_app_feature_flags_v3/get_feature_flags_v3_by_app_id_flags_by_flag_name	Retrieve the current status of the app's feature flags. No request body is included.	flagName (string) appId (integer)
public_app_feature_flags_v3/put_feature_flags_v3_by_app_id_flags_by_flag_name	Set a feature flag for an app. For example, update the hs-hide-crm-cards flag's defaultState to ON to hide classic CRM cards from new installs.	flagName (string) appId (integer) data: { . overrideState (string) . defaultState (string) } (object) required
public_app_feature_flags_v3/delete_feature_flags_v3_by_app_id_flags_by_flag_name	Delete a feature flag in an app. For example, delete the hs-release-app-cards flag after all accounts have been migrated.	flagName (string) appId (integer)
quotes/post_crm_v3_objects_quotes_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
quotes/get_crm_v3_objects_quotes_by_quote_id	Read an Object identified by quoteId. quoteId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	quoteId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
quotes/delete_crm_v3_objects_quotes_by_quote_id	Move an Object identified by quoteId to the recycling bin.	quoteId (string)
quotes/patch_crm_v3_objects_quotes_by_quote_id	Perform a partial update of an Object identified by quoteIdor optionally a unique property value as specified by the idProperty query param. quoteId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	quoteId (string) idProperty (string) data: { . properties (object) } (object) required
quotes/post_crm_v3_objects_quotes_batch_archive	Archive a batch of quotes by ID	data: { . inputs (array) } (object) required
quotes/post_crm_v3_objects_quotes_batch_create	Create a batch of quotes	data: { . inputs (array) } (object) required
quotes/post_crm_v3_objects_quotes_batch_update	Update a batch of quotes by internal ID, or unique property values	data: { . inputs (array) } (object) required
quotes/get_crm_v3_objects_quotes	Read a page of quotes. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
quotes/post_crm_v3_objects_quotes	Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided.	data: { . associations (array) . properties (object) } (object) required
quotes/post_crm_v3_objects_quotes_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
quotes/post_crm_v3_objects_quotes_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
schemas/get_crm_object_schemas_v3_schemas	Returns all object schemas that have been defined for your account.	archived (boolean)
schemas/post_crm_object_schemas_v3_schemas	Define a new object schema, along with custom properties and associations. The entire object schema, including its object type ID, properties, and associations will be returned in the response.	data: { . secondaryDisplayProperties (array) . requiredProperties (array) . searchableProperties (array) . primaryDisplayProperty (string) . name (string) . description (string) . associatedObjects (array) . properties (array) . labels } (object) required
schemas/get_crm_object_schemas_v3_schemas_by_object_type	Returns an existing object schema.	objectType (string)
schemas/delete_crm_object_schemas_v3_schemas_by_object_type	Deletes a schema. Any existing records of this schema must be deleted first. Otherwise this call will fail.	objectType (string) archived (boolean)
schemas/patch_crm_object_schemas_v3_schemas_by_object_type	Update the details for an existing object schema.	objectType (string) data: { . secondaryDisplayProperties (array) . requiredProperties (array) . searchableProperties (array) . clearDescription (boolean) . primaryDisplayProperty (string) . description (string) . restorable (boolean) . labels } (object) required
schemas/post_crm_object_schemas_v3_schemas_by_object_type_associations	Defines a new association between the primary schema's object type and other object types.	objectType (string) data: { . fromObjectTypeId (string) . name (string) . toObjectTypeId (string) } (object) required
schemas/delete_crm_object_schemas_v3_schemas_by_object_type_associations_by_association_identifier	Removes an existing association from a schema.	objectType (string) associationIdentifier (string)
send_event_completions/post_events_v3_send_batch	Send multiple event completions at once.	data: { . inputs (array) } (object) required
send_event_completions/post_events_v3_send	Send data for a single event completion.	data: { . occurredAt (string) . eventName (string) . utk (string) . uuid (string) . email (string) . properties (object) . objectId (string) } (object) required
sequences/get_automation_v4_sequences_enrollments_contact_by_contact_id	No description available	contactId (string)
sequences/get_automation_v4_sequences	No description available	userId (string) required after (string) limit (integer) name (string)
sequences/post_automation_v4_sequences_enrollments	No description available	userId (string) required data: { . contactId (string) . senderEmail (string) . sequenceId (string) } (object) required
sequences/get_automation_v4_sequences_by_sequence_id	No description available	sequenceId (string) userId (string) required
services/post_crm_v3_objects_by_object_type_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	objectType (string) archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
services/get_crm_v3_objects_by_object_type_by_object_id	Read an Object identified by objectId. objectId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	objectType (string) objectId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
services/delete_crm_v3_objects_by_object_type_by_object_id	Move an Object identified by objectId to the recycling bin.	objectType (string) objectId (string)
services/patch_crm_v3_objects_by_object_type_by_object_id	Perform a partial update of an Object identified by objectIdor optionally a unique property value as specified by the idProperty query param. objectId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	objectType (string) objectId (string) idProperty (string) data: { . properties (object) } (object) required
services/post_crm_v3_objects_by_object_type_batch_archive	Archive a batch of objects by ID	objectType (string) data: { . inputs (array) } (object) required
services/post_crm_v3_objects_by_object_type_batch_create	Create a batch of objects	objectType (string) data: { . inputs (array) } (object) required
services/post_crm_v3_objects_by_object_type_batch_update	Update a batch of objects by internal ID, or unique property values	objectType (string) data: { . inputs (array) } (object) required
services/get_crm_v3_objects_by_object_type	Read a page of objects. Control what is returned via the properties query param.	objectType (string) limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
services/post_crm_v3_objects_by_object_type	Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.	objectType (string) data: { . associations (array) . properties (object) } (object) required
services/post_crm_v3_objects_by_object_type_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	objectType (string) data: { . inputs (array) } (object) required
services/post_crm_v3_objects_by_object_type_search	No description available	objectType (string) data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
singlesend/post_marketing_v4_email_single_send	No description available	data: { . customProperties (object) . emailId (integer) . message . contactProperties (object) } (object) required
site_search/get_cms_v3_site_search_indexed_data_by_content_id	For a given account and document ID page ID, blog post ID, HubDB row ID, etc., return all indexed data for that document. This is useful when debugging why a particular document is not returned from a custom search.	contentId (string) type (string)
site_search/get_cms_v3_site_search_search	Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path.	q (string) limit (integer) offset (integer) language (string) matchPrefix (boolean) autocomplete (boolean) popularityBoost (number) boostLimit (number) boostRecent (string) tableId (integer) hubdbQuery (string) domain (array) type (array) pathPrefix (array) property (array) length (string) groupId (array)
source_code/get_cms_v3_source_code_by_environment_content_by_path	Downloads the byte contents of the file at the specified path in the specified environment.	environment (string) path (string)
source_code/put_cms_v3_source_code_by_environment_content_by_path	Upserts a file at the specified path in the specified environment. Accepts multipart/form-data content type.	environment (string) path (string)
source_code/post_cms_v3_source_code_by_environment_content_by_path	Creates a file at the specified path in the specified environment. Accepts multipart/form-data content type. Throws an error if a file already exists at the specified path.	environment (string) path (string)
source_code/delete_cms_v3_source_code_by_environment_content_by_path	Deletes the file at the specified path in the specified environment.	environment (string) path (string)
source_code/get_cms_v3_source_code_by_environment_metadata_by_path	Gets the metadata object for the file at the specified path in the specified environment.	environment (string) path (string) properties (string)
source_code/post_cms_v3_source_code_by_environment_validate_by_path	Validates the file contents passed to the endpoint given a specified path and environment. Accepts multipart/form-data content type.	path (string) environment (string)
source_code/post_cms_v3_source_code_extract_async	Extract a zip file in the developer file system. Extraction status can be checked with the /extract/async/tasks/taskId/status endpoint below.	data: { . path (string) } (object) required
source_code/get_cms_v3_source_code_extract_async_tasks_by_task_id_status	Get the status of an extraction by the taskId returned from the initial extract/async request.	taskId (integer)
subscriptions/post_communication_preferences_v4_statuses_batch_write	Update the subscription status for a set of contacts.	data: { . inputs (array) } (object) required
subscriptions/get_communication_preferences_v4_statuses_by_subscriber_id_string_unsubscribe_all	Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response results array will be empty.	subscriberIdString (string) businessUnitId (integer) verbose (boolean) channel (string) required
subscriptions/post_communication_preferences_v4_statuses_by_subscriber_id_string_unsubscribe_all	Unsubscribe a contact from all email subscriptions.	subscriberIdString (string) businessUnitId (integer) verbose (boolean) channel (string) required
subscriptions/post_communication_preferences_v4_statuses_batch_read	Batch retrieve subscription statuses for a set of contacts.	businessUnitId (integer) channel (string) required data: { . inputs (array) } (object) required
subscriptions/post_communication_preferences_v4_statuses_batch_unsubscribe_all	Unsubscribe a set of contacts from all email subscriptions.	businessUnitId (integer) verbose (boolean) channel (string) required data: { . inputs (array) } (object) required
subscriptions/get_communication_preferences_v4_definitions	Get a list of subscription status definitions from the account.	businessUnitId (integer) includeTranslations (boolean)
subscriptions/post_communication_preferences_v4_statuses_batch_unsubscribe_all_read	Checks whether a set of contacts have opted out of all communications.	businessUnitId (integer) channel (string) required data: { . inputs (array) } (object) required
subscriptions/get_communication_preferences_v4_statuses_by_subscriber_id_string	Retrieve a contact's current email subscription preferences.	subscriberIdString (string) businessUnitId (integer) channel (string) required
subscriptions/post_communication_preferences_v4_statuses_by_subscriber_id_string	Set the subscription status of a specific contact.	subscriberIdString (string) data: { . statusState (string) . channel (string) . legalBasis (string) . subscriptionId (integer) . legalBasisExplanation (string) } (object) required
tags/post_cms_v3_blogs_tags_batch_update	Update the Blog Tag objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
tags/post_cms_v3_blogs_tags_multi_language_update_languages	Explicitly set new languages for each Blog Tag in a multi-language group.	data: { . languages (object) . primaryId (string) } (object) required
tags/post_cms_v3_blogs_tags_multi_language_detach_from_lang_group	Detach a Blog Tag from a multi-language group.	data: { . id (string) } (object) required
tags/post_cms_v3_blogs_tags_batch_create	Create the Blog Tag objects detailed in the request body.	data: { . inputs (array) } (object) required
tags/post_cms_v3_blogs_tags_batch_archive	Delete the Blog Tag objects identified in the request body.	data: { . inputs (array) } (object) required
tags/put_cms_v3_blogs_tags_multi_language_set_new_lang_primary	Set a Blog Tag as the primary language of a multi-language group.	data: { . id (string) } (object) required
tags/post_cms_v3_blogs_tags_batch_read	Retrieve the Blog Tag objects identified in the request body.	archived (boolean) data: { . inputs (array) } (object) required
tags/get_cms_v3_blogs_tags	Get the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean) property (string)
tags/post_cms_v3_blogs_tags	Create a new Blog Tag.	data: { . deletedAt (string) . created (string) . name (string) . language (string) . id (string) . translatedFromId (integer) . updated (string) } (object) required
tags/post_cms_v3_blogs_tags_multi_language_attach_to_lang_group	Attach a Blog Tag to a multi-language group.	data: { . language (string) . id (string) . primaryId (string) . primaryLanguage (string) } (object) required
tags/get_cms_v3_blogs_tags_by_object_id	Retrieve the Blog Tag object identified by the id in the path.	objectId (string) archived (boolean) property (string)
tags/delete_cms_v3_blogs_tags_by_object_id	Delete the Blog Tag object identified by the id in the path.	objectId (string) archived (boolean)
tags/patch_cms_v3_blogs_tags_by_object_id	Sparse updates a single Blog Tag object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified.	objectId (string) archived (boolean) data: { . deletedAt (string) . created (string) . name (string) . language (string) . id (string) . translatedFromId (integer) . updated (string) } (object) required
tags/post_cms_v3_blogs_tags_multi_language_create_language_variation	Create a new language variation from an existing Blog Tag	data: { . name (string) . language (string) . id (string) . primaryLanguage (string) } (object) required
tasks/post_crm_v3_objects_tasks_batch_read	Read a batch of tasks by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
tasks/get_crm_v3_objects_tasks_by_task_id	Read an Object identified by taskId. taskId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	taskId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
tasks/delete_crm_v3_objects_tasks_by_task_id	Move an Object identified by taskId to the recycling bin.	taskId (string)
tasks/patch_crm_v3_objects_tasks_by_task_id	Perform a partial update of an Object identified by taskId. taskId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.	taskId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
tasks/post_crm_v3_objects_tasks_batch_archive	Archive a batch of tasks by ID	data: { . inputs (array) } (object) required
tasks/post_crm_v3_objects_tasks_batch_create	Create a batch of tasks	data: { . inputs (array) } (object) required
tasks/post_crm_v3_objects_tasks_batch_update	Update a batch of tasks by internal ID, or unique property values	data: { . inputs (array) } (object) required
tasks/get_crm_v3_objects_tasks	Read a page of tasks. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
tasks/post_crm_v3_objects_tasks	Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
tasks/post_crm_v3_objects_tasks_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
tasks/post_crm_v3_objects_tasks_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
taxes/post_crm_v3_objects_taxes_batch_read	Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
taxes/get_crm_v3_objects_taxes_by_tax_id	Read an Object identified by taxId. taxId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	taxId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
taxes/delete_crm_v3_objects_taxes_by_tax_id	Move an Object identified by taxId to the recycling bin.	taxId (string)
taxes/patch_crm_v3_objects_taxes_by_tax_id	Perform a partial update of an Object identified by taxIdor optionally a unique property value as specified by the idProperty query param. taxId refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	taxId (string) idProperty (string) data: { . properties (object) } (object) required
taxes/post_crm_v3_objects_taxes_batch_archive	Archive a batch of taxes by ID	data: { . inputs (array) } (object) required
taxes/post_crm_v3_objects_taxes_batch_create	Create a batch of taxes	data: { . inputs (array) } (object) required
taxes/post_crm_v3_objects_taxes_batch_update	Update a batch of taxes by internal ID, or unique property values	data: { . inputs (array) } (object) required
taxes/get_crm_v3_objects_taxes	Read a page of taxes. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
taxes/post_crm_v3_objects_taxes	Create a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided.	data: { . associations (array) . properties (object) } (object) required
taxes/post_crm_v3_objects_taxes_batch_upsert	Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.	data: { . inputs (array) } (object) required
taxes/post_crm_v3_objects_taxes_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
test_child_api/get_account_info_v3_activity_login	Get login activity.	after (string) limit (integer) userId (integer)
test_child_api/get_account_info_v3_activity_audit_logs	No description available	after (string) limit (integer) actingUserId (array) occurredAfter (string) occurredBefore (string) sort (array)
test_child_api/get_account_info_v3_api_usage_daily	Get daily API usage	No parameters
test_child_api/get_account_info_v3_details	Get account details	No parameters
test_child_api/get_account_info_v3_activity_security	Get security activity	after (string) limit (integer) userId (integer) fromTimestamp (integer)
tickets/post_crm_v3_objects_tickets_batch_read	Retrieve a batch of tickets by ID ticketId or unique property value idProperty.	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
tickets/get_crm_v3_objects_tickets_by_ticket_id	Retrieve a ticket by its ID ticketId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	ticketId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
tickets/delete_crm_v3_objects_tickets_by_ticket_id	Archive a ticket, sending it to the recycling bin. Deleted tickets can be restored within 90 days of deletion. Learn more about restoring recordshttps://knowledge.hubspot.com/records/restore-deleted-records.	ticketId (string)
tickets/patch_crm_v3_objects_tickets_by_ticket_id	Update a ticket by ID ticketId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	ticketId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
tickets/post_crm_v3_objects_tickets_merge	Merge two tickets, combining them into one ticket record.	data: { . objectIdToMerge (string) . primaryObjectId (string) } (object) required
tickets/post_crm_v3_objects_tickets_batch_archive	Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about restoring recordshttps://knowledge.hubspot.com/records/restore-deleted-records.	data: { . inputs (array) } (object) required
tickets/post_crm_v3_objects_tickets_batch_create	Create a batch of tickets. The inputs array can contain a properties object to define property values for the ticket, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . inputs (array) } (object) required
tickets/post_crm_v3_objects_tickets_batch_update	Update a batch of tickets by ID ticketId or unique property value idProperty. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.	data: { . inputs (array) } (object) required
tickets/get_crm_v3_objects_tickets	Retrieve a ticket by its ID ticketId or by a unique property idProperty. You can specify what is returned using the properties query parameter.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
tickets/post_crm_v3_objects_tickets	Create a single ticket. Include a properties object to define property valueshttps://developers.hubspot.com/docs/guides/api/crm/properties for the ticket, along with an associations array to define associationshttps://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4 with other CRM records.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
tickets/post_crm_v3_objects_tickets_batch_upsert	Create and update a batch of tickets by a unique property. Tickets that don't exist will be created, while existing tickets will be updated.	data: { . inputs (array) } (object) required
tickets/post_crm_v3_objects_tickets_search	Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about CRM searchhttps://developers.hubspot.com/docs/guides/api/crm/search make-a-search-request.	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
timeline/get_integrators_timeline_v3_events_by_event_template_id_by_event_id_detail	This will take the detailTemplate from the event template and return an object rendering the specified event. If the template references extraData that isn't found in the event, it will be ignored and we'll render without it.	eventTemplateId (string) eventId (string)
timeline/post_integrators_timeline_v3_events	Creates an instance of a timeline event based on an event template. Once created, this event is immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via objectPropertyName, this call will also attempt to updates those properties, or add them if they don't exist.	data: { . eventTemplateId (string) . extraData (object) . timelineIFrame . domain (string) . tokens (object) . id (string) . utk (string) . email (string) . objectId (string) . timestamp (string) } (object) required
timeline/put_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id_tokens_by_token_name	This will update the existing token on an event template. Name and type can't be changed on existing tokens.	eventTemplateId (string) tokenName (string) appId (integer) data: { . options (array) . label (string) . objectPropertyName (string) } (object) required
timeline/delete_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id_tokens_by_token_name	This will remove the token from an existing template. Existing events and CRM objects will still retain the token and its mapped object properties, but new ones will not. The timeline will still display this property for older CRM objects if it's still referenced in the template Markdown. New events will not. Any lists or reports referencing deleted tokens will no longer return new contacts, but old ones will still exist in the lists.	eventTemplateId (string) tokenName (string) appId (integer)
timeline/get_integrators_timeline_v3_events_by_event_template_id_by_event_id	This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object.	eventTemplateId (string) eventId (string)
timeline/post_integrators_timeline_v3_events_batch_create	Creates multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via objectPropertyName, this call will also attempt to updates those properties, or add them if they don't exist.	data: { . inputs (array) } (object) required
timeline/get_integrators_timeline_v3_events_by_event_template_id_by_event_id_render	This will take either the headerTemplate or detailTemplate from the event template and render for the specified event as HTML. If the template references extraData that isn't found in the event, it will be ignored and we'll render without it.	eventTemplateId (string) eventId (string) detail (boolean)
timeline/get_integrators_timeline_v3_by_app_id_event_templates	Use this to list all event templates owned by your app.	appId (integer)
timeline/post_integrators_timeline_v3_by_app_id_event_templates	Event templates define the general structure for a custom timeline event. This includes formatted copy for its heading and details, as well as any custom property definitions. The event could be something like viewing a video, registering for a webinar, or filling out a survey. A single app can define multiple event templates. Event templates will be created for contacts by default, but they can be created for companies, tickets, and deals as well. Each event template contains its own set of t	appId (integer) data: { . detailTemplate (string) . name (string) . tokens (array) . headerTemplate (string) . objectType (string) } (object) required
timeline/get_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id	View the current state of a specific template and its tokens.	eventTemplateId (string) appId (integer)
timeline/put_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id	Updates an existing template and its tokens. This is primarily used to update the headerTemplate/detailTemplate, and those changes will take effect for existing events. You can also update or replace all the tokens in the template here instead of doing individual API calls on the /tokens endpoint.	eventTemplateId (string) appId (integer) data: { . detailTemplate (string) . name (string) . tokens (array) . id (string) . headerTemplate (string) } (object) required
timeline/delete_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id	This will delete the event template. All associated events will be removed from search results and the timeline UI. This action can't be undone, so it's highly recommended that you stop using any associated events before deleting a template.	eventTemplateId (string) appId (integer)
timeline/post_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id_tokens	Once you've defined an event template, it's likely that you'll want to define tokens for it as well. You can do this on the event template itself or update individual tokens here. Event type tokens allow you to attach custom data to events displayed in a timeline or used for list segmentation. You can also use objectPropertyName to associate any CRM object properties. This will allow you to fully build out CRM objects. Token names should be unique across the template.	eventTemplateId (string) appId (integer) data: { . createdAt (string) . options (array) . name (string) . label (string) . objectPropertyName (string) . type (string) . updatedAt (string) } (object) required
transactional_single_send/post_marketing_v3_transactional_single_email_send	Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.	data: { . customProperties (object) . emailId (integer) . message . contactProperties (object) } (object) required
transactional_single_send/get_marketing_v3_transactional_smtp_tokens	Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.	campaignName (string) emailCampaignId (string) after (string) limit (integer)
transactional_single_send/post_marketing_v3_transactional_smtp_tokens	Create a SMTP API token.	data: { . createContact (boolean) . campaignName (string) } (object) required
transactional_single_send/post_marketing_v3_transactional_smtp_tokens_by_token_id_password_reset	Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.	tokenId (string)
transactional_single_send/get_marketing_v3_transactional_smtp_tokens_by_token_id	Query a single token by ID.	tokenId (string)
transactional_single_send/delete_marketing_v3_transactional_smtp_tokens_by_token_id	Delete a single token by ID.	tokenId (string)
url_redirects/get_cms_v3_url_redirects	Returns all existing URL redirects. Results can be limited and filtered by creation or updated date.	createdAt (string) createdAfter (string) createdBefore (string) updatedAt (string) updatedAfter (string) updatedBefore (string) sort (array) after (string) limit (integer) archived (boolean)
url_redirects/post_cms_v3_url_redirects	Creates and configures a new URL redirect.	data: { . isTrailingSlashOptional (boolean) . isMatchQueryString (boolean) . redirectStyle (integer) . routePrefix (string) . isMatchFullUrl (boolean) . isProtocolAgnostic (boolean) . destination (string) . isOnlyAfterNotFound (boolean) . isPattern (boolean) . precedence (integer) } (object) required
url_redirects/get_cms_v3_url_redirects_by_url_redirect_id	Returns the details for a single existing URL redirect by ID.	urlRedirectId (string)
url_redirects/delete_cms_v3_url_redirects_by_url_redirect_id	Delete one existing redirect, so it is no longer mapped.	urlRedirectId (string)
url_redirects/patch_cms_v3_url_redirects_by_url_redirect_id	Updates the settings for an existing URL redirect.	urlRedirectId (string) data: { . isTrailingSlashOptional (boolean) . redirectStyle (integer) . isMatchQueryString (boolean) . created (string) . isMatchFullUrl (boolean) . destination (string) . isOnlyAfterNotFound (boolean) . isPattern (boolean) . precedence (integer) . routePrefix (string) . isProtocolAgnostic (boolean) . id (string) . updated (string) } (object) required
user_provisioning/get_settings_v3_users_teams	View teams for this account	No parameters
user_provisioning/get_settings_v3_users_roles	Retrieves the roles on an account	No parameters
user_provisioning/get_settings_v3_users	Retrieves a list of users from an account	limit (integer) after (string)
user_provisioning/post_settings_v3_users	New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot.	data: { . firstName (string) . lastName (string) . primaryTeamId (string) . sendWelcomeEmail (boolean) . roleId (string) . secondaryTeamIds (array) . email (string) } (object) required
user_provisioning/get_settings_v3_users_by_user_id	Retrieves a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.	userId (string) idProperty (string)
user_provisioning/put_settings_v3_users_by_user_id	Modifies a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.	userId (string) idProperty (string) data: { . firstName (string) . lastName (string) . primaryTeamId (string) . roleId (string) . secondaryTeamIds (array) } (object) required
user_provisioning/delete_settings_v3_users_by_user_id	Removes a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.	userId (string) idProperty (string)
users/post_crm_v3_objects_users_batch_read	Read a batch of users by internal ID, or unique property values	archived (boolean) data: { . propertiesWithHistory (array) . idProperty (string) . inputs (array) . properties (array) } (object) required
users/get_crm_v3_objects_users_by_user_id	Read an Object identified by userId. userId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.	userId (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean) idProperty (string)
users/delete_crm_v3_objects_users_by_user_id	Move an Object identified by userId to the recycling bin.	userId (string)
users/patch_crm_v3_objects_users_by_user_id	Perform a partial update of an Object identified by userId. userId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.	userId (string) idProperty (string) data: { . objectWriteTraceId (string) . properties (object) } (object) required
users/post_crm_v3_objects_users_batch_archive	Archive a batch of users by ID	data: { . inputs (array) } (object) required
users/post_crm_v3_objects_users_batch_create	Create a batch of users	data: { . inputs (array) } (object) required
users/post_crm_v3_objects_users_batch_update	Update a batch of users	data: { . inputs (array) } (object) required
users/get_crm_v3_objects_users	Read a page of users. Control what is returned via the properties query param.	limit (integer) after (string) properties (array) propertiesWithHistory (array) associations (array) archived (boolean)
users/post_crm_v3_objects_users	Create a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided.	data: { . associations (array) . objectWriteTraceId (string) . properties (object) } (object) required
users/post_crm_v3_objects_users_batch_upsert	Create or update a batch of users by unique property values	data: { . inputs (array) } (object) required
users/post_crm_v3_objects_users_search	No description available	data: { . query (string) . limit (integer) . after (string) . sorts (array) . properties (array) . filterGroups (array) } (object) required
video_conferencing_extension/get_crm_v3_extensions_videoconferencing_settings_by_app_id	Return the settings for a video conference application with the specified ID.	appId (integer)
video_conferencing_extension/put_crm_v3_extensions_videoconferencing_settings_by_app_id	Updates the settings for a video conference application with the specified ID.	appId (integer) data: { . userVerifyUrl (string) . fetchAccountsUri (string) . createMeetingUrl (string) . updateMeetingUrl (string) . deleteMeetingUrl (string) } (object) required
video_conferencing_extension/delete_crm_v3_extensions_videoconferencing_settings_by_app_id	Deletes the settings for a video conference application with the specified ID.	appId (integer)
visitor_identification/post_visitor_identification_v3_tokens_create	Generates a new visitor identification token. This token will be unique every time this endpoint is called, even if called with the same email address. This token is temporary and will expire after 12 hours	data: { . firstName (string) . lastName (string) . email (string) } (object) required
webhooks/get_webhooks_v3_by_app_id_settings	Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date.	appId (integer)
webhooks/put_webhooks_v3_by_app_id_settings	Update webhook settings for the specified app.	appId (integer) data: { . throttling . targetUrl (string) } (object) required
webhooks/delete_webhooks_v3_by_app_id_settings	Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created.	appId (integer)
webhooks/get_webhooks_v3_by_app_id_subscriptions_by_subscription_id	Retrieve a specific event subscription by ID.	subscriptionId (integer) appId (integer)
webhooks/delete_webhooks_v3_by_app_id_subscriptions_by_subscription_id	Delete an existing event subscription by ID.	subscriptionId (integer) appId (integer)
webhooks/patch_webhooks_v3_by_app_id_subscriptions_by_subscription_id	Update an existing event subscription by ID.	subscriptionId (integer) appId (integer) data: { . active (boolean) } (object) required
webhooks/get_webhooks_v3_by_app_id_subscriptions	Retrieve event subscriptions for the specified app.	appId (integer)
webhooks/post_webhooks_v3_by_app_id_subscriptions	Create new event subscription for the specified app.	appId (integer) data: { . objectTypeId (string) . propertyName (string) . active (boolean) . eventType (string) } (object) required
webhooks/post_webhooks_v3_by_app_id_subscriptions_batch_update	Batch create event subscriptions for the specified app.	appId (integer) data: { . inputs (array) } (object) required