Get all products

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Sales Professional

Required Scope:

Get all products from a portal, up to 100 per request.

By default you will only get a few system fields for any products in the response. If you want to get specific properties, you'll need to use the &properties= parameter in the request URL. The parameter can be included multiple times, so you can request any properties you may need. See the parameter descriptions below and the examples for more details.

Required Parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters	How to use	Description
Offset	offset= Used in the request URL	Used to get the next set of results. Check the value of hasMore in the response to see if there are more products to get. If `hasMore` is true, you use the returned `offset` value in the `&offset=` parameter of the next request to get the next set of records.
Product properties	&properties= Used in the request URL This parameter can be included multiple times.	By default, only the ID and a few other system fields are returned for the products. You can include product properties in the response by requesting them in the URL. This parameter can be included multiple times to request multiple properties. See the example for more details.
Product properties (with history)	&propertiesWithHistory= Used in the request URL	This parameter behaves exactly like the properties parameter above, with the exception that properties included with this parameter also return the full version history for the property.

JSON

Example GET URL: https://api.hubapi.com/crm-objects/v1/objects/products/paged Example response: { "objects": [ { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1642736, "properties": {}, "version": 2, "isDeleted": false }, { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1642767, "properties": {}, "version": 1, "isDeleted": false }, { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1642796, "properties": {}, "version": 2, "isDeleted": false } ], "hasMore": false, "offset": 1642796 } Example GET URL (with properties): https://api.hubapi.com/crm-objects/v1/objects/products/paged?properties=name&properties=description&properties=price Example response: { "objects": [ { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1642736, "properties": { "price": { "versions": [ { "name": "price", "value": "10.00", "timestamp": 1525287810508, "source": "API", "sourceVid": [] } ], "value": "10.00", "timestamp": 1525287810508, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "An updated product", "timestamp": 1525287810508, "source": "API", "sourceVid": [] } ], "value": "An updated product", "timestamp": 1525287810508, "source": "API", "sourceId": null }, "description": { "versions": [ { "name": "description", "value": "This product has an updated description and price.", "timestamp": 1525287810508, "source": "API", "sourceVid": [] } ], "value": "This product has an updated description and price.", "timestamp": 1525287810508, "source": "API", "sourceId": null } }, "version": 2, "isDeleted": false }, { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1642767, "properties": { "price": { "versions": [ { "name": "price", "value": "27.50", "timestamp": 1525287096980, "source": "API", "sourceVid": [] } ], "value": "27.50", "timestamp": 1525287096980, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "A new product", "timestamp": 1525287096980, "source": "API", "sourceVid": [] } ], "value": "A new product", "timestamp": 1525287096980, "source": "API", "sourceId": null }, "description": { "versions": [ { "name": "description", "value": "A description of this product.", "timestamp": 1525287096980, "source": "API", "sourceVid": [] } ], "value": "A description of this product.", "timestamp": 1525287096980, "source": "API", "sourceId": null } }, "version": 1, "isDeleted": false }, { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1642796, "properties": { "price": { "versions": [ { "name": "price", "value": "85.00", "timestamp": 1525292253568, "source": "API", "sourceVid": [] } ], "value": "85.00", "timestamp": 1525292253568, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "A second new product", "timestamp": 1525289943771, "source": "API", "sourceVid": [] } ], "value": "A second new product", "timestamp": 1525289943771, "source": "API", "sourceId": null }, "description": { "versions": [ { "name": "description", "value": "This is an updated product, it's getting a price change.", "timestamp": 1525292253568, "source": "API", "sourceVid": [] } ], "value": "This is an updated product, it's getting a price change.", "timestamp": 1525292253568, "source": "API", "sourceId": null } }, "version": 2, "isDeleted": false } ], "hasMore": false, "offset": 1642796 }