Skip to content

HubSpot: Retrieve a contact

HubSpot contacts.getContact: arguments, response, policy and SDK examples.

← Contacts operations · Get started

Operation hubspot.contacts_get_contact

Provider route: GET /crm/objects/2026-09/contacts/{contactId}. 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["contacts"]["getContact"]>[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.contacts.getContact(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.contacts.get_contact(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contactIdstringRequired within parentPattern: .+
queryobjectOptionalAdditional keys: not allowed
query.archivedbooleanOptionalDefault: false
query.associationsarrayOptional
query.associations[]stringEach item
query.idPropertystringOptional
query.propertiesarrayOptional
query.properties[]stringEach item
query.propertiesWithHistoryarrayOptional
query.propertiesWithHistory[]stringEach item

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a contact — response body

Referenced models: Retrieve a contact — response body

Retrieve a contact — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archivedbooleanRequired within parentA boolean indicating whether this object has been archived.
archivedAtstringOptionalThe date and time when this object was archived, in ISO 8601 format.
Format: date-time
associationsobjectOptionalA map of associated object types to their respective associated IDs.
Additional keys: see wildcard field
associations.*ModelAdditional keysExpand Retrieve a contact — response body — associations value
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 object.
objectWriteTraceIdstringOptionalAn identifier used for tracing the write operations on 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 their values along with a history of changes, including timestamps.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Create a contact — 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 access this object.
warningsarrayOptionalA list of warnings associated with this object, each containing a category, message, and context.
warnings[]ModelEach itemExpand Create a contact — response body — warnings item

Referenced models: Retrieve a contact — response body — associations value, Create a contact — response body — warnings item, Create a contact — response body — properties With History value item

Retrieve a contact — response body — associations value
FieldTypePresenceDescription and constraints
$objectRootRepresents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
pagingModelOptionalExpand Search for contacts — response body — paging
resultsarrayRequired within parentAn array of associated IDs, where each item represents an associated object. The array contains objects of type 'AssociatedId'.
results[]ModelEach itemExpand Retrieve a contact — response body — associations value results item

Referenced models: Retrieve a contact — response body — associations value results item, Search for contacts — response body — paging

Create a contact — 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 string values for each context key.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.
Create a contact — response body — properties With History value item
FieldTypePresenceDescription and constraints
$objectRootProperty model that includes timestamp.
sourceIdstringOptionalA string identifier for the specific source of the value.
sourceLabelstringOptionalA string label that provides a human-readable name for the source.
sourceTypestringRequired within parentA string indicating the type of source from which the value originated.
timestampstringRequired within parentThe date and time when the value was recorded, in ISO 8601 format.
Format: date-time
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeAn integer representing the ID of the user who last updated the value.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valuestringRequired within parentThe actual value being recorded. It is a string.
Retrieve a contact — response body — associations value results item
FieldTypePresenceDescription and constraints
$objectRootContains the id and type of an association
idstringRequired within parentThe unique identifier for the associated object. This is a string value.
typestringRequired within parentThe type of association between the objects. This is a string value.
Search for contacts — 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 Retrieve contacts — response body — paging next
prevModelOptionalExpand Search for contacts — response body — paging prev

Referenced models: Retrieve contacts — response body — paging next, Search for contacts — response body — paging prev

Retrieve contacts — 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 that indicates the position after the last item on the current page. This token is used to fetch the next set of results.
linkstringOptionalA string URL that provides a direct link to the next page of results.
Search for contacts — 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 used to identify the position before the current page in a paginated list.
linkstringOptionalA string URL that provides a direct link to the previous page of results.

SDK function policy ID: hubspot.contacts_get_contact. Catalog operation: contacts_get_contact. 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.contacts.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.