There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get a line item by ID

Last updated January 7, 2025

GET  /crm-objects/v1/objects/line_items/:id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Sales Professional

Required Scope:

e-commerce

Get a specific line item by its ID.

By default, the response will only include the ID. You can get specific properties in the response by using the &properties= parameter in the URL, and that parameter can be included multiple times to get multiple properties. See the example 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.
Line item ID :id
Used in the request URL		 The ID of the line item you want to get.

Optional Parameters How to use Description
Line item properties &properties=
Used in the request URL		 By default, only the ID.  You can include other 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.
Include deleted includeDeletes=true
Used in the request URL		 By default, deleted records will not be returned by the API. You can include this parameter to make sure that records are returned even when they are deleted.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/crm-objects/v1/objects/line_items/9845651?properties=hs_product_id Example response: { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9845651, "properties": { "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645342", "sourceVid": [] } ], "value": "1645342", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false } Example GET with properties: https://api.hubapi.com/crm-objects/v1/objects/line_items/9845651?properties=quantity&properties=price&properties=name&properties=hs_product_id Example response: { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9845651, "properties": { "quantity": { "versions": [ { "name": "quantity", "value": "25", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "25", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "price": { "versions": [ { "name": "price", "value": "27.50", "timestamp": 1525299376761, "source": "API", "sourceVid": [] } ], "value": "27.50", "timestamp": 1525299376761, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "A custom name for the product for this line item.", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "A custom name for the product for this line item.", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645342", "sourceVid": [] } ], "value": "1645342", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false }