Get all line items

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Sales Professional

Required Scope:

Get all line items from an account, up to 100 per request.

By default you will only get the object ID, the portal ID (HubSpot Account ID) and a deleted field to indicate if the line item as been archived or not 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.

Note: Line items created using the HubSpot sales tools may not always have a hs_product_id set. Products created from the deal line item editor will not be added to your product library and will therefore not have a hs_product_id. See the details in this knowledge doc for more information.

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 line items 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.
Line items 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 line items. You can include other line item 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.
Line item 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/line_items/paged Example response: { "objects": [ { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9843068, "properties": { "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1642736", "sourceVid": [] } ], "value": "1642736", "timestamp": 0, "source": null, "sourceId": null } }, "version": 2, "isDeleted": false }, { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9867220, "properties": { "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645187", "sourceVid": [] } ], "value": "1645187", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false } ], "hasMore": false, "offset": 9867220 } Example GET URL (with properties): https://api.hubapi.com/crm-objects/v1/objects/line_items/paged?properties=name&properties=price&properties=quantity Example response: { "objects": [ { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9843068, "properties": { "quantity": { "versions": [ { "name": "quantity", "value": "50", "timestamp": 1525367734768, "source": "API", "sourceVid": [] } ], "value": "50", "timestamp": 1525367734768, "source": "API", "sourceId": null }, "price": { "versions": [ { "name": "price", "value": "9.50", "timestamp": 1525367734768, "source": "API", "sourceVid": [] } ], "value": "9.50", "timestamp": 1525367734768, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "A custom name for the product for this line item. Discounting 5% on bulk purchase.", "timestamp": 1525368457923, "source": "API", "sourceVid": [] } ], "value": "A custom name for the product for this line item. Discounting 5% on bulk purchase.", "timestamp": 1525368457923, "source": "API", "sourceId": null }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1642736", "sourceVid": [] } ], "value": "1642736", "timestamp": 0, "source": null, "sourceId": null } }, "version": 2, "isDeleted": false }, { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9867220, "properties": { "quantity": { "versions": [ { "name": "quantity", "value": "15", "timestamp": 1525368534412, "source": "API", "sourceVid": [] } ], "value": "15", "timestamp": 1525368534412, "source": "API", "sourceId": null }, "price": { "versions": [ { "name": "price", "value": "100.00", "timestamp": 1525368534412, "source": "API", "sourceVid": [] } ], "value": "100.00", "timestamp": 1525368534412, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "Magical widgets - special order", "timestamp": 1525368534412, "source": "API", "sourceVid": [] } ], "value": "Magical widgets - special order", "timestamp": 1525368534412, "source": "API", "sourceId": null }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645187", "sourceVid": [] } ], "value": "1645187", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false } ], "hasMore": false, "offset": 9867220 }