HubSpot: Search — partner Clients search Partner Clients

← Partner clients operations · Get started

Operation hubspot.partner_clients_search_partner_clients

Provider route: POST /crm/objects/2026-09/partner_clients/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["partnerClients"]["searchPartnerClients"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.partnerClients.searchPartnerClients(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.partner_clients.search_partner_clients(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Search — partner Clients search Partner Clients — request body — body

Referenced models: Search — partner Clients search Partner Clients — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search — partner Clients search Partner Clients — response body

Referenced models: Search — partner Clients search Partner Clients — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Search — partner Clients search Partner Clients — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search — partner Clients search Partner Clients — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a simple public object returned in the response.
results[]	Model	Each item	Expand Create — partner Clients create — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search — partner Clients search Partner Clients — response body — paging, Create — partner Clients create — response body

Search — partner Clients search Partner Clients — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string token used for pagination to retrieve results after a specific point. This is typically used to fetch the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results. Each filter group contains multiple filters that are applied together.
filterGroups[]	Model	Each item	Expand Search — partner Clients search Partner Clients — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. This helps control the size of the response. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the CRM objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against object properties.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results. Each string represents a property name followed by a direction (e.g., 'propertyName ASC' or 'propertyName DESC').
sorts[]	string	Each item

Referenced models: Search — partner Clients search Partner Clients — request body — body filter Groups item

Search — partner Clients search Partner Clients — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	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	Model	Optional	Expand List — partner Clients get Partner Clients — response body — paging next
prev	Model	Optional	Expand Search — partner Clients search Partner Clients — response body — paging prev

Referenced models: List — partner Clients get Partner Clients — response body — paging next, Search — partner Clients search Partner Clients — response body — paging prev

Create — partner Clients create — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string representing the trace ID for write operations on this object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their historical values, where each value is an array of objects containing the value and its timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create — partner Clients create — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string containing the URL associated with this object.
warnings	array	Optional	An array of warnings related to this object, where each warning includes a category, message, and context.
warnings[]	Model	Each item	Expand Read — projects get Project — response body — warnings item

Referenced models: Read — projects get Project — response body — warnings item, Create — partner Clients create — response body — properties With History value item

Search — partner Clients search Partner Clients — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of Filter objects that specify the conditions for the search query. Each filter defines a property, an operator, and a value to filter the objects by.
filters[]	Model	Each item	Expand Search — partner Clients search Partner Clients — request body — body filter Groups item filters item

Referenced models: Search — partner Clients search Partner Clients — request body — body filter Groups item filters item

List — partner Clients get Partner Clients — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor to indicate the position after the last item in the current page, allowing retrieval of the next set of results.
link	string	Optional	A string representing the URL link to the next page of results.

Search — partner Clients search Partner Clients — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used to retrieve the previous page of results.
link	string	Optional	A URL string that provides a link to the previous page of results.

Read — projects get Project — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string representing the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Create — partner Clients create — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string identifier for the specific source of the value.
sourceLabel	string	Optional	A string label providing additional context about the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	An integer representing the ID of the user who last updated the value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	A string representing the value associated with the timestamp.

Policy, approvals and errors

SDK function policy ID: hubspot.partner_clients_search_partner_clients. Catalog operation: partner_clients_search_partner_clients. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["crm.objects.partner-clients.read"]

Official provider source