HubSpot: Search — partner Services search Partner Services
HubSpot partnerServices.searchPartnerServices: arguments, response, policy and SDK examples.
← Partner services operations · Get started
Operation hubspot.partner_services_search_partner_services
Provider route: POST /crm/objects/2026-09/partner_services/search. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["partnerServices"]["searchPartnerServices"]>[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.partnerServices.searchPartnerServices(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_services.search_partner_services(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Search — partner Services search Partner Services — request body — body |
Referenced models: Search — partner Services search Partner Services — request body — body
Response
Section titled “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 Services search Partner Services — response body |
Referenced models: Search — partner Services search Partner Services — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Search — partner Services search Partner Services — 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 Services search Partner Services — response body — paging |
results | array | Required within parent | An array of SimplePublicObject items, each representing an individual object in the collection. |
results[] | Model | Each item | Expand Create — partner Services 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 Services search Partner Services — response body — paging, Create — partner Services create — response body
Search — partner Services search Partner Services — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a search request |
after | string | Required within parent | A string used as a paging cursor token to retrieve results after a specific point in the result set. |
filterGroups | array | Required within parent | An array of filter groups used to refine the search results. Each filter group contains multiple filters that are applied together. |
filterGroups[] | Model | Each item | Expand Search — partner Services search Partner Services — request body — body filter Groups item |
limit | integer | Required within parent | An integer indicating the maximum number of results to return. Format: int32 |
properties | array | Required within parent | An array of strings specifying the properties to be returned 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 fields and order by which the search results should be sorted. |
sorts[] | string | Each item |
Referenced models: Search — partner Services search Partner Services — request body — body filter Groups item
Search — partner Services search Partner Services — 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 Services get Partner Services — response body — paging next |
prev | Model | Optional | Expand Search — partner Services search Partner Services — response body — paging prev |
Referenced models: List — partner Services get Partner Services — response body — paging next, Search — partner Services search Partner Services — response body — paging prev
Create — partner Services 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 used to trace the write operations for 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 arrays of historical values, where each value includes a timestamp and source information. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Create — partner Services 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 representing 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 Create — partner Services create — response body — warnings item |
Referenced models: Create — partner Services create — response body — warnings item, Create — partner Services create — response body — properties With History value item
Search — partner Services search Partner Services — 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 define the individual filtering criteria within the group. Each filter specifies a property, an operator, and a value or range of values to filter by. |
filters[] | Model | Each item | Expand Search — partner Services search Partner Services — request body — body filter Groups item filters item |
Referenced models: Search — partner Services search Partner Services — request body — body filter Groups item filters item
List — partner Services get Partner Services — 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 retrieve the next set of results in a paginated response. |
link | string | Optional | A string containing the URL link to the next page of results. |
Search — partner Services search Partner Services — 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 that indicates the cursor position before the current page, used to fetch the previous set of results. |
link | string | Optional | A string URL that provides a direct link to the previous page of results. |
Create — partner Services create — 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 indicating the category of the warning. |
context | object | Required within parent | An object providing additional context about the warning, where each key is a string and each value is a string. Additional keys: see wildcard field |
context.* | string | Additional keys | |
message | string | Required within parent | A string containing the warning message. |
Create — partner Services 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 | The recorded value as a string. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.partner_services_search_partner_services. Catalog operation: partner_services_search_partner_services. 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-services.read"]