HubSpot: Search objects — taxes search Taxes
HubSpot taxes.searchTaxes: arguments, response, policy and SDK examples.
← Taxes operations · Get started
Operation hubspot.taxes_search_taxes
Provider route: POST /crm/objects/2026-09/taxes/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["taxes"]["searchTaxes"]>[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.taxes.searchTaxes(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.taxes.search_taxes(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 objects — taxes search Taxes — request body — body |
Referenced models: Search objects — taxes search Taxes — 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 objects — taxes search Taxes — response body |
Referenced models: Search objects — taxes search Taxes — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Search objects — taxes search Taxes — 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 objects — taxes search Taxes — response body — paging |
results | array | Required within parent | An array of SimplePublicObject items, each representing an individual object within the collection. |
results[] | Model | Each item | Expand Create — taxes create Tax — 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 objects — taxes search Taxes — response body — paging, Create — taxes create Tax — response body
Search objects — taxes search Taxes — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a search request |
after | string | Required within parent | A string representing the paging cursor token. It is used to fetch the next set of results in a paginated response. |
filterGroups | array | Required within parent | An array of filter groups used to specify the criteria for filtering search results. Each filter group contains a set of filters that are combined using logical AND operations. |
filterGroups[] | Model | Each item | Expand Search objects — taxes search Taxes — request body — body filter Groups item |
limit | integer | Required within parent | An integer indicating the maximum number of results to return. This limits the number of objects included in the search results. Format: int32 |
properties | array | Required within parent | An array of strings specifying the properties to be included in the search results. Only the specified properties will be returned for each object. |
properties[] | string | Each item | |
query | string | Optional | A string representing a search query to match against the CRM objects. This query is used to perform a full-text search across specified properties. |
sorts | array | Required within parent | An array of strings that define the sorting order of the search results. Each string specifies a property to sort by, optionally followed by 'ASC' or 'DESC' to indicate ascending or descending order. |
sorts[] | string | Each item |
Referenced models: Search objects — taxes search Taxes — request body — body filter Groups item
Search objects — taxes search Taxes — 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 — taxes get Taxes — response body — paging next |
prev | Model | Optional | Expand Search objects — taxes search Taxes — response body — paging prev |
Referenced models: List — taxes get Taxes — response body — paging next, Search objects — taxes search Taxes — response body — paging prev
Create — taxes create Tax — 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 CRM object. |
objectWriteTraceId | string | Optional | An identifier used for tracing the write operations related to this object. |
properties | object | Required within parent | A map of property names to their current values for this object. Additional keys: see wildcard field |
properties.* | string | Additional keys | |
propertiesWithHistory | object | Optional | A map of property names to arrays of past values, each with a timestamp indicating when the value was set. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Read — taxes get Tax — 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 | The URL link to this object. |
warnings | array | Optional | An array of warnings related to this object, each containing a category, message, and context. |
warnings[] | Model | Each item | Expand Read — taxes get Tax — response body — warnings item |
Referenced models: Read — taxes get Tax — response body — warnings item, Read — taxes get Tax — response body — properties With History value item
Search objects — taxes search Taxes — 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 criteria for the search. Each filter specifies a property name, operator, and value(s) to apply the filter logic. |
filters[] | Model | Each item | Expand Search objects — taxes search Taxes — request body — body filter Groups item filters item |
Referenced models: Search objects — taxes search Taxes — request body — body filter Groups item filters item
List — taxes get Taxes — 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 fetch the next set of results in a paginated response. |
link | string | Optional | A URL string that points to the next page of results in the paginated response. |
Search objects — taxes search Taxes — 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 position in the result set before the current page. |
link | string | Optional | A string URL that provides a direct link to the previous page of results. |
Read — taxes get Tax — 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 for the warning, with properties as key-value pairs. Additional keys: see wildcard field |
context.* | string | Additional keys | |
message | string | Required within parent | A string containing the warning message. |
Read — taxes get Tax — response body — properties With History value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Property model that includes timestamp. |
sourceId | string | Optional | An identifier for the source of the value. This is a string. |
sourceLabel | string | Optional | A label describing the source of the value. This is a string. |
sourceType | string | Required within parent | The type of source from which the value originated. This is a string. |
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 | The ID of the user who last updated this value. This is an integer. Format: int32 |
updatedByUserId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value | string | Required within parent | The actual value being recorded. This is a string. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.taxes_search_taxes. Catalog operation: taxes_search_taxes. 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.line_items.read"]