See Stacksync in action with a solution architect. Book a demo ↗
StacksyncDocs
StacksyncCommunityBook a demoContact Support
HomeTwo-way syncAgentic WorkflowsGeniesEnterprise OSMCPEDIConnectorsSecurity and Other ResourcesChangelogDevelopers

HubSpot

The simplest HubSpot API you have ever seen!

Overview

The Stacksync HubSpot API Proxy provides secure, centralized access to HubSpot APIs through a single HTTPS endpoint.
You authenticate with your Stacksync service token. Stacksync manages the underlying HubSpot connection.

Use it for on‑demand operational tasks, admin actions, and low‑volume reads/writes.
For continuous, high‑volume sync, use Stacksync Syncs instead.

Operations:

Get

Retrieve the details of up to 100 records in a single request. The number of records returned matches the number of ids provided.

You can optionally specify a fields array to control which properties are returned for each record. If fields is omitted or an empty array ("fields": []), all available fields for each record are included in the response.

Supported objects:

  • Companies
  • Contacts
  • Deals
  • Feedback submissions
  • Line items
  • Products
  • Quotes
  • Discounts
  • Fees
  • Taxes
  • Tickets
  • Goals
  • Custom objects

Planned:

  • Owners
  • Associations
  • Audit Logs
  • Pipelines
  • Stages
curl -X POST https://eu.api-proxy.stacksync.com/v1/object/get/Contact \
        -H "Authorization: Bearer your_api_proxy_service_token" \
        -H "Content-Type: application/json" \
        -d '{"data": {"ids": ["227400", "264150"], "fields": ["firstname"]}}'

Example response body:

{
	"data": [
		{
			"archived": false,
			"createdAt": "2024-01-31T13:17:43.128Z",
			"id": "227400",
			"properties": {
				"createdate": "2024-01-31T13:17:43.128Z",
				"firstname": null,
				"hs_object_id": "227400",
				"lastmodifieddate": "2024-02-02T15:05:54.183Z"
			},
			"updatedAt": "2024-02-02T15:05:54.183Z"
		},
		{
			"archived": false,
			"createdAt": "2024-01-31T13:17:43.128Z",
			"id": "227386",
			"properties": {
				"createdate": "2024-01-31T13:17:43.128Z",
				"firstname": null,
				"hs_object_id": "227386",
				"lastmodifieddate": "2024-01-31T13:28:37.746Z"
			},
			"updatedAt": "2024-01-31T13:28:37.746Z"
		}
	]
}

Add a custom field to a HubSpot object

Add a custom field (property) to a HubSpot object. Both standard and custom objects are supported.

Required request body parameters:

  • name – Internal property name used by the API.
  • label – Human‑readable label displayed in the HubSpot UI.
  • type – Underlying data type of the property (for example, string, number, date).
  • fieldType – How the property is rendered in HubSpot (for example, text input, dropdown).
  • groupName – Property group to which the property will belong.

Each type supports one or more valid fieldType values. Using an incompatible combination will cause the request to fail. For the full list of supported types, fieldTypes, and valid combinations, refer to the HubSpot property settings documentation.

curl -X POST https://eu.api-proxy.stacksync.com/v1/object/add_custom_field/<object_name> \
        -H "Authorization: Bearer your_api_proxy_service_token" \
        -H "Content-Type: application/json" \
        -d '{"data": {"name": "field_name", "label": "field_label", "type": "string", "fieldType": "text", "groupName": "companyinformation"}}'

Example Response Body:

{
    "data": {
	"archived": false,
	"calculated": false,
	"createdAt": "2024-01-11T23:43:00.066Z",
	"createdUserId": "46192612",
	"description": "",
	"displayOrder": -1,
	"externalOptions": false,
	"fieldType": "text",
	"formField": false,
	"groupName": "companyinformation",
	"hasUniqueValue": false,
	"hidden": false,
	"label": "StacksyncID",
	"modificationMetadata": {
		"archivable": true,
		"readOnlyDefinition": false,
		"readOnlyValue": false
	},
	"name": "enumeration",
	"options": [],
	"type": "string",
	"updatedAt": "2024-01-11T23:43:00.066Z",
	"updatedUserId": "46192612"
   },
   "message": "Custom field added successfully"
}

Example requests for different field types for the HubSpot Company object:

curl -X POST https://eu.api-proxy.stacksync.com/v1/object/add_custom_field/company \
        -H "Authorization: Bearer *****" \
        -H "Content-Type: application/json" \
        -d '{
                "data": {
                    "name": "custom_field",
                    "label": "Custom Field", 
                    "type": "string",  
                    "fieldType": "text",
                    "groupName": "companyinformation"
                }
            }'

Pass Through

Make a request to any HubSpot API which supports OAuth by providing the URL, Request Method and the Request Body.Use the Pass Through operation to invoke any HubSpot API endpoint that supports OAuth authentication by specifying the full URL, HTTP method, and optional request body.

HubSpot’s developer documentation clearly indicates which endpoints are compatible with OAuth access tokens: https://developers.hubspot.com/docs/api/overview

HubSpot API docs for POST /crm/v3/objects/companies/batch/archive, with the "OAuth" badge highlighted next to "Private apps".

When you call this operation, Stacksync sends a request to the target HubSpot URL using the method and body you provide. The request body is optional and may be omitted for methods such as GET or DELETE.

curl -X [GET | POST | PUT | PATCH | DELETE] 
https://eu.api-proxy.stacksync.com/v1/proxy/INSERT_REQUEST_URL_HERE \
-H "Authorization: Bearer your_api_proxy_service_token" \
-d 'Optional'

Example request:

Create a new HubSpot Contact

curl -X POST https://eu.api-proxy.stacksync.com/v1/proxy/https://api.hubapi.com/crm/v3/objects/contacts/batch/create \
        -H "Authorization: Bearer your_api_proxy_service_token" \
        -H "Content-Type: application/json" \
        -d '{"inputs": [{"properties":{	"email": "john@company.com"}}]}'

Example response:

{
	"completedAt": "2024-02-12T02:18:24.961Z",
	"results": [
		{
			"archived": false,
			"createdAt": "2024-02-12T02:18:24.748Z",
			"id": "441751",
			"properties": {
				"createdate": "2024-02-12T02:18:24.748Z",
				"email": "john@company.com",
				"hs_all_contact_vids": "441751",
				"hs_email_domain": "company.com",
				"hs_is_contact": "true",
				"hs_is_unworked": "true",
				"hs_lifecyclestage_lead_date": "2024-02-12T02:18:24.748Z",
				"hs_marketable_status": "false",
				"hs_marketable_until_renewal": "false",
				"hs_object_id": "441751",
				"hs_object_source": "INTEGRATION",
				"hs_object_source_id": "1749998",
				"hs_object_source_label": "INTEGRATION",
				"hs_pipeline": "contacts-lifecycle-pipeline",
				"lastmodifieddate": "2024-02-12T02:18:24.748Z",
				"lifecyclestage": "lead"
			},
			"updatedAt": "2024-02-12T02:18:24.748Z"
		}
	],
	"startedAt": "2024-02-12T02:18:24.720Z",
	"status": "COMPLETE"
}

Get the schema / columns of a standard HubSpot object

curl -X GET 
https://eu.api-proxy.stacksync.com/v1/proxy/https://api.hubapi.com/crm/v3/properties/<object_name> \
-H "Authorization: Bearer your_api_proxy_service_token" \

Get the schema / columns of custom Hubspot objects

curl -X GET 
https://eu.api-proxy.stacksync.com/v1/proxy/https://api.hubapi.com/crm/v3/schemas \
-H "Authorization: Bearer your_api_proxy_service_token"

Salesforce

The most straightforward way to access the Salesforce API for your team.

Attio

Secure, streamlined access to the Attio API for your team.

On this page

OverviewGetAdd a custom field to a HubSpot objectPass ThroughCreate a new HubSpot ContactGet the schema / columns of a standard HubSpot objectGet the schema / columns of custom Hubspot objects