Skip to content

HubSpot: List teams

HubSpot teams.getTeams: arguments, response, policy and SDK examples.

← Teams operations · Get started

Operation hubspot.teams_get_teams

Provider route: GET /settings/teams/2026-09. 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["teams"]["getTeams"]>[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.teams.getTeams(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.teams.get_teams(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.afterstringOptional
query.limitintegerOptionalFormat: int32

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List teams — response body

Referenced models: List teams — response body

List teams — response body
FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand List teams — response body — paging
resultsarrayRequired within parentAn array of team responses, each representing a team object.
results[]ModelEach itemExpand Create Team — response body

Referenced models: Create Team — response body, List teams — response body — paging

Create Team — response body
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier for the team, represented as a string.
namestringRequired within parentThe name of the team, represented as a string.
parentTeamIdstringOptionalThe unique identifier of the parent team, if applicable, represented as a string.
List teams — response body — paging
FieldTypePresenceDescription and constraints
$objectRootPaging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
nextModelOptionalExpand List teams — response body — paging next

Referenced models: List teams — response body — paging next

List teams — 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 representing the cursor position after the last successfully read resource. This is used to fetch the next set of results.
linkstringOptionalA string URL that provides the direct link to the next page of results.

SDK function policy ID: hubspot.teams_get_teams. Catalog operation: teams_get_teams. 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: ["settings.users.teams.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.