HubSpot: List members
HubSpot teams.getTeamMembers: arguments, response, policy and SDK examples.
← Teams operations · Get started
Operation hubspot.teams_get_team_members
Provider route: GET /settings/teams/2026-09/{teamId}/members. 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["teams"]["getTeamMembers"]>[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.getTeamMembers(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.teams.get_team_members(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.teamId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.after | string | Optional | |
query.limit | integer | Optional | Format: int32 |
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 List members — response body |
Referenced models: List members — response body
Schemas
Section titled “Schemas”List members — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand List teams — response body — paging |
results | array | Required within parent | An array of team member responses, each represented by a TeamMemberResponse object. |
results[] | Model | Each item | Expand Add Team Members — response body |
Referenced models: Add Team Members — response body, List teams — response body — paging
Add Team Members — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | The type of membership the user has in the team. Valid values are 'DEFAULT' and 'EXTRA'. Known values: DEFAULT, EXTRA |
userId | string | Required within parent | The unique identifier for the user, represented as a string. |
List teams — response body — paging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. |
next | Model | Optional | Expand List teams — response body — paging next |
Referenced models: List teams — response body — paging next
List teams — 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 representing the cursor position after the last successfully read resource. This is used to fetch the next set of results. |
link | string | Optional | A string URL that provides the direct link to the next page of results. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.teams_get_team_members. Catalog operation: teams_get_team_members. 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"]