---
title: "Search for line items"
method: POST
path: "/crm/objects/2025-09/line_items/search"
tags: ["Search"]
---

# Search for line items

`POST /crm/objects/2025-09/line_items/search`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/crm/objects/2025-09/line_items/search`
- Auth: none required

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.

## Request body

- PublicObjectSearchRequest: Describes a search request
  - `after` string, required: A paging cursor token for retrieving subsequent pages.
  - `filterGroups` FilterGroup[], required: Up to 6 groups of filters defining additional query criteria.
    - `filters` Filter[], required: A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.
      - `highValue` string: The upper boundary value when using ranged-based filters.
      - `operator` 'BETWEEN' | 'CONTAINS_TOKEN' | 'EQ' | 'GT' | 'GTE' | 'HAS_PROPERTY' | 'IN' | 'LT' | 'LTE' | 'NEQ' | 'NOT_CONTAINS_TOKEN' | 'NOT_HAS_PROPERTY' | 'NOT_IN', required: The comparison operator used in the filter, such as "EQ" or "GT".
      - `propertyName` string, required: The name of the property to apply the filter to.
      - `value` string: The value to match against the property.
      - `values` string[]: The values to match against the property.
  - `limit` integer, required: The maximum results to return, up to 200 objects.
  - `properties` string[], required: A list of property names to include in the response.
  - `query` string: The search query string, up to 3000 characters.
  - `sorts` string[], required: Specifies sorting order based on object properties.

## Response `200`

successful operation

- CollectionResponseWithTotalSimplePublicObject: Represents a list of simple objects returned from an API request, along with the total count of objects available.
  - `paging` Paging: Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
    - `next` NextPage: Specifies the paging information needed to retrieve the next set of results in a paginated API response
      - `after` string, required: A paging cursor token for retrieving subsequent pages.
      - `link` string: A URL that can be used to retrieve the next page results.
    - `prev` PreviousPage: specifies the paging information needed to retrieve the previous set of results in a paginated API response
      - `before` string, required: A paging cursor token for retrieving previous pages.
      - `link` string: A URL that can be used to retrieve the previous pages' results.
  - `results` SimplePublicObject[], required: An array containing the simple public objects returned in the current page of the response. This property is required.
    - `archived` boolean, required: Whether the object is archived.
    - `archivedAt` string, date-time: The timestamp when the object was archived, in ISO 8601 format.
    - `createdAt` string, date-time, required: The timestamp when the object was created, in ISO 8601 format.
    - `id` string, required: The unique ID of the object.
    - `objectWriteTraceId` string: An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error.
    - `properties` object, required: Key-value pairs representing the properties of the object.
    - `propertiesWithHistory` object: Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information.
    - `updatedAt` string, date-time, required: The timestamp when the object was last updated, in ISO 8601 format.
    - `url` string: The URL associated with the object.
    - `warnings` PublicObjectWarning[]
      - `category` string, required: The classification of the warning, indicating the type or nature of the issue.
      - `context` object, required: Additional information or metadata about the warning, providing context for understanding the issue.
      - `message` string, required: The text of the warning message, providing information about the issue or alert.
  - `total` integer, required: The number of available results

## Other responses

- `default`: An error occurred.

## Changes

- **2026-09-25** (2025-09) `d5544951ce9c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hubspot/apis/crm-line-items/changes/crm/objects/2025-09/line_items/search/post.md)

---

[API](https://skmtc.dev/hubspot/apis/crm-line-items.md) - [All operations](https://skmtc.dev/hubspot/apis/crm-line-items/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/crm-line-items/revisions/1fdabd43f5ba?raw)