Skip to content

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.

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 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.taxes.search_taxes(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Search objects — taxes search Taxes — request body — body

Referenced models: Search objects — taxes search Taxes — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Search objects — taxes search Taxes — response body

Referenced models: Search objects — taxes search Taxes — response body

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

Search objects — taxes search Taxes — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a list of simple objects returned from an API request, along with the total count of objects available.
pagingModelOptionalExpand Search objects — taxes search Taxes — response body — paging
resultsarrayRequired within parentAn array of SimplePublicObject items, each representing an individual object within the collection.
results[]ModelEach itemExpand Create — taxes create Tax — response body
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe number of available results
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRootDescribes a search request
afterstringRequired within parentA string representing the paging cursor token. It is used to fetch the next set of results in a paginated response.
filterGroupsarrayRequired within parentAn 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[]ModelEach itemExpand Search objects — taxes search Taxes — request body — body filter Groups item
limitintegerRequired within parentAn integer indicating the maximum number of results to return. This limits the number of objects included in the search results.
Format: int32
propertiesarrayRequired within parentAn array of strings specifying the properties to be included in the search results. Only the specified properties will be returned for each object.
properties[]stringEach item
querystringOptionalA string representing a search query to match against the CRM objects. This query is used to perform a full-text search across specified properties.
sortsarrayRequired within parentAn 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[]stringEach item

Referenced models: Search objects — taxes search Taxes — request body — body filter Groups item

Search objects — taxes search Taxes — response body — paging
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
nextModelOptionalExpand List — taxes get Taxes — response body — paging next
prevModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootA simple public object.
archivedbooleanRequired within parentA boolean indicating whether this object is archived.
archivedAtstringOptionalThe date and time when this object was archived, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe date and time when this object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique identifier for this CRM object.
objectWriteTraceIdstringOptionalAn identifier used for tracing the write operations related to this object.
propertiesobjectRequired within parentA map of property names to their current values for this object.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalA 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.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — taxes get Tax — response body — properties With History value item
updatedAtstringRequired within parentThe date and time when this object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalThe URL link to this object.
warningsarrayOptionalAn array of warnings related to this object, each containing a category, message, and context.
warnings[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootRepresents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filtersarrayRequired within parentAn 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[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentA string token used as a cursor to fetch the next set of results in a paginated response.
linkstringOptionalA URL string that points to the next page of results in the paginated response.
Search objects — taxes search Taxes — response body — paging prev
FieldTypePresenceDescription and constraints
$objectRootspecifies the paging information needed to retrieve the previous set of results in a paginated API response
beforestringRequired within parentA string token that indicates the position in the result set before the current page.
linkstringOptionalA string URL that provides a direct link to the previous page of results.
Read — taxes get Tax — response body — warnings item
FieldTypePresenceDescription and constraints
$objectRootRepresents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
categorystringRequired within parentA string representing the category of the warning.
contextobjectRequired within parentAn object providing additional context for the warning, with properties as key-value pairs.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.
Read — taxes get Tax — response body — properties With History value item
FieldTypePresenceDescription and constraints
$objectRootProperty model that includes timestamp.
sourceIdstringOptionalAn identifier for the source of the value. This is a string.
sourceLabelstringOptionalA label describing the source of the value. This is a string.
sourceTypestringRequired within parentThe type of source from which the value originated. This is a string.
timestampstringRequired within parentThe date and time when the value was recorded, in ISO 8601 format.
Format: date-time
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeThe ID of the user who last updated this value. This is an integer.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valuestringRequired within parentThe actual value being recorded. This is a string.

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.