HubSpot: Search — projects search Projects

← Projects operations · Get started

Operation hubspot.projects_search_projects

Provider route: POST /crm/objects/2026-09/projects/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["projects"]["searchProjects"]>[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.projects.searchProjects(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.projects.search_projects(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 — projects search Projects — request body — body

Referenced models: Search — projects search Projects — 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 — projects search Projects — response body

Referenced models: Search — projects search Projects — response body

Schemas

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

Search — projects search Projects — 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 — projects search Projects — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a public object with its properties.
results[]	Model	Each item	Expand Create — projects create Project — 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 — projects search Projects — response body — paging, Create — projects create Project — response body

Search — projects search Projects — 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 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 searching objects. Each filter group contains filters that define the conditions objects must meet.
filterGroups[]	Model	Each item	Expand Search — projects search Projects — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings indicating which properties of the objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied to the objects.
sorts	array	Required within parent	An array of strings specifying the properties by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search — projects search Projects — request body — body filter Groups item

Search — projects search Projects — 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 — projects get Projects — response body — paging next
prev	Model	Optional	Expand Search — projects search Projects — response body — paging prev

Referenced models: Search — projects search Projects — response body — paging prev, List — projects get Projects — response body — paging next

Create — projects create Project — 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 for this object, 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 their historical values, where each historical value includes a timestamp and the value at that time. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — projects get Project — 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 of 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, Read — projects get Project — response body — properties With History value item

Search — projects search Projects — 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. Each filter specifies a condition to be applied in the search query. This property is required.
filters[]	Model	Each item	Expand Search — projects search Projects — request body — body filter Groups item filters item

Referenced models: Search — projects search Projects — request body — body filter Groups item filters item

Search — projects search Projects — 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 identify the position before the current page in the pagination sequence.
link	string	Optional	A URL string that provides a direct link to the previous page of results.

List — projects get Projects — 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 page of results.
link	string	Optional	A string representing the URL link to the next 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.

Read — projects get Project — 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 representing the identifier of the source from which the value was obtained.
sourceLabel	string	Optional	A string providing a label or name for the source of the value.
sourceType	string	Required within parent	A string specifying the type of source from which the value was obtained.
timestamp	string	Required within parent	A string in date-time format indicating when the value was recorded. 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 of the property at the given timestamp.

Policy, approvals and errors

SDK function policy ID: hubspot.projects_search_projects. Catalog operation: projects_search_projects. 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.projects.read"]

Official provider source