Search for line items

Execute a search for line items based on filters, properties, and sorting options provided in the request body. This endpoint allows you to retrieve line items that match specific conditions, facilitating targeted data retrieval in CRM operations.

post/crm/v3/objects/line_items/search

Request body

afterstring required

A paging cursor token for retrieving subsequent pages.

limitinteger required

The maximum results to return, up to 200 objects.

propertiesstring[] required

A list of property names to include in the response.

querystring

The search query string, up to 3000 characters.

sortsstring[] required

Specifies sorting order based on object properties.

Response

successful operation

totalinteger required

The number of available results

Example response

{
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    }
  },
  "results": [
    {
      "archived": false,
      "createdAt": "2019-10-30T03:30:17.883Z",
      "id": "512",
      "properties": {
        "property_checkbox": "false",
        "property_date": "1572480000000",
        "property_dropdown": "choice_b",
        "property_multiple_checkboxes": "chocolate;strawberry",
        "property_number": "17",
        "property_radio": "option_1",
        "property_string": "value"
      },
      "updatedAt": "2019-12-07T16:50:06.678Z"
    }
  ]
}

Changes

Changed in 14 of the 56 revisions of this API.727

Sep 4, 2026v34eb104fa4ed72See the full diff
- ○
  the security scope crm.objects.line_items.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope e-commerce was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
Sep 2, 2026v38f97a0e8a2441See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v30ac07674715e1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
Jul 13, 2026v3a3ce821b367e1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v3f28bb3df969b1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 23, 2026v3a3ce821b367e3See the full diff
- ○
  the security scope crm.objects.line_items.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope e-commerce was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jun 15, 2026v3ab35e9ef0c8033See the full diff
- ▲
  removed the enum value BETWEEN(VALUE of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value HIGH_VALUE) of the request property ////
  request-property-enum-value-removed
- ▲
  the / request property type changed from object to string
  request-property-type-changed
- ○
  the security scope crm.objects.line_items.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope e-commerce was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
- ○
  added the new BETWEEN enum value to the request property ////
  request-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 15, 2026v3a1ef8b0912922See the full diff
- ○
  the security scope crm.objects.line_items.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope e-commerce was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
Jun 15, 2026v30f669e3909af24See the full diff
- ▲
  removed the enum value BETWEEN of the request property ////
  request-property-enum-value-removed
- ▲
  the / request property type changed from string to object
  request-property-type-changed
- ○
  the security scope crm.objects.line_items.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope e-commerce was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
- ○
  added the new BETWEEN(VALUE enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new HIGH_VALUE) enum value to the request property ////
  request-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 15, 2026v3ae062b0d7e2e2See the full diff
- ○
  the security scope crm.objects.line_items.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope e-commerce was removed from the endpoint's security scheme oauth2
  api-security-scope-removed

Full history (14 revisions)