Get all line items

GET  /crm-objects/v1/objects/line_items/paged

This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

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 all line items from a portal, up to 100 per request.

By default you will only get a few system fields and the hs_product_id property for any line items 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 API Key Authorization: Bearer {token} header or hapikey={key} query parameter. 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, a few other system fields, and the hs_product_id 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.