Objects Search

HubSpot

Search records of a selected HubSpot CRM object type by property filters and sorting.

Capability: CRM record management
Current price: $0.0025/request
Availability: Requires connected account

What this API does

Searches one supported standard or custom CRM object type using a free-text query, filter groups, sorts and selected properties. Scrollport owns the paging cursor; each upstream page costs $0.0025.

Agents select this operation with tool ID hubspot.objects-search, then check its current inputs and price before a run.

Inputs and outputs

Input

bodyobject · required

Bounded request body sent to the connected application.

max_pagesinteger · optional

Maximum number of result pages to request.

minimum: 1 · maximum: 10

pathobject · required

Identifier path for the authorised connected-app record.

Output

pagesnumber

Returned pages value.

resultsarray

Returned results value.

Example request and output

Inspect returns this reviewed example, its estimated cost and the current input schema. Run calculates the estimate for your actual input.

Request

{
  "tool_id": "hubspot.objects-search",
  "input": {
    "body": {
      "limit": 1,
      "properties": [
        "name",
        "domain",
        "description"
      ],
      "filterGroups": [
        {
          "filters": [
            {
              "value": "YOUR-HUBSPOT-OBJECT-ID",
              "operator": "EQ",
              "propertyName": "hs_object_id"
            }
          ]
        }
      ]
    },
    "path": {
      "objectType": "0-2"
    },
    "max_pages": 1
  }
}

Output

{
  "pages": 1,
  "results": [
    {
      "id": "400000000001",
      "archived": false,
      "properties": {
        "name": "Northstar Research (Sample)",
        "domain": "northstar-research.invalid",
        "description": "Research partner profile used to demonstrate CRM retrieval and updates."
      }
    }
  ]
}

Errors and limitations

connection_required: This capability acts on your own HubSpot account, which isn't connected yet.Open connect_url, approve access, then retry this run unchanged.
permission_required: The connected HubSpot grant does not include a scope required by this object type.Reconnect HubSpot and approve the requested scope, or choose an object type available to this account.

Use Objects Search with Scrollport

Get started

Connect your app account to let your agent use its tools. Your credentials stay private, and you pay only for successful runs.

Connect your first agent to receive $1 trial credit.