Skip to main content
POST
/
crm
/
objects
/
2026-09-beta
/
{objectType}
/
search
Search for forecasts
curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-09-beta/{objectType}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "after": "<string>",
  "filterGroups": [
    {
      "filters": [
        {
          "operator": "BETWEEN",
          "propertyName": "<string>",
          "highValue": "<string>",
          "value": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "limit": 123,
  "properties": [
    "<string>"
  ],
  "sorts": [
    "<string>"
  ],
  "query": "<string>"
}
'
{
  "results": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "objectWriteTraceId": "<string>",
      "propertiesWithHistory": {},
      "url": "<string>"
    }
  ],
  "total": 123,
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

Supported products

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
objectType
string
required

The type of CRM object to search for, such as contacts, companies, or deals.

Body

application/json

Describes a search request

​
after
string
required

A paging cursor token for retrieving subsequent pages.

​
filterGroups
object[]
required

Up to 6 groups of filters defining additional query criteria.

​
limit
integer<int32>
required

The maximum results to return, up to 200 objects.

​
properties
string[]
required

A list of property names to include in the response.

​
sorts
string[]
required

Specifies sorting order based on object properties.

​
query
string

The search query string, up to 3000 characters.

Response

successful operation

Represents a list of simple objects returned from an API request, along with the total count of objects available.

​
results
object[]
required
​
total
integer<int32>
required

The number of available results

​
paging
object
Last modified on March 30, 2026