HighLevel: Get Contact

← Contacts operations · Get started

Operation gohighlevel.get_contact

Provider route: GET /contacts/{contactId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["contacts"]["getContact"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(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_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.contacts.get_contact(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.contactId	string	Required within parent

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 Get Contact — response body

Referenced models: Get Contact — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Get Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
contact	JSON	Optional	Contact details
contact (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website

Referenced models: Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website

Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website

Field	Type	Presence	Description and constraints
$	object	Root
address1	string	Optional	Street address of the contact
assignedTo	string	Optional	User Id the contact is assigned to
attachments	string	Optional	List of attachment URLs associated with the contact
attributionSource	JSON	Optional	First-touch attribution source details for the contact
attributionSource (allOf 1)	Model	All variants apply	Expand Get Contacts By Business Id — response body — contacts item attributions item
businessId	string	Optional	Business Id the contact is associated with
city	string	Optional	City of the contact
companyName	string	Optional	Company name of the contact
country	string	Optional	Country of the contact
customFields	array	Optional	List of custom field values for the contact
customFields[]	Model	Each item	Expand Get Contacts By Business Id — response body — contacts item custom Fields item
dateAdded	string	Optional	Date and time the contact was added (ISO 8601)
dateOfBirth	string	Optional	Date of birth of the contact (YYYY-MM-DD)
dateUpdated	string	Optional	Date and time the contact was last updated (ISO 8601)
dnd	boolean	Optional	Whether Do Not Disturb is enabled for the contact
dndSettings	JSON	Optional	Per-channel DND settings for the contact
dndSettings (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website dnd Settings call, email, fb, gmb, sms, whats App
email	string	Optional	Email address of the contact
emailLowerCase	string	Optional	Lowercase version of the contact email
firstName	string	Optional	First name of the contact
firstNameLowerCase	string	Optional	Lowercase version of the contact first name
fullNameLowerCase	string	Optional	Lowercase version of the contact full name
id	string	Optional	Unique identifier of the contact
keyword	string	Optional	Search keyword associated with the contact
lastActivity	string	Optional	Date and time of last activity on this contact (ISO 8601)
lastAttributionSource	JSON	Optional	Last-touch attribution source details for the contact
lastAttributionSource (allOf 1)	Model	All variants apply	Expand Get Contacts By Business Id — response body — contacts item attributions item
lastName	string	Optional	Last name of the contact
lastNameLowerCase	string	Optional	Lowercase version of the contact last name
locationId	string	Optional	Location Id the contact belongs to
name	string	Optional	Full name of the contact
phone	string	Optional	Phone number of the contact
postalCode	string	Optional	Postal code of the contact
source	string	Optional	Source from which the contact was created
ssn	string	Optional	Social Security Number (if applicable)
state	string	Optional	State of the contact
tags	array	Optional	List of tags associated with the contact
tags[]	string	Each item
timezone	string	Optional	Timezone of the contact
type	string	Optional	Contact type classification
visitorId	string	Optional	visitorId is the Unique ID assigned to each Live chat visitor.
website	string	Optional	Website URL of the contact

Referenced models: Get Contacts By Business Id — response body — contacts item attributions item, Get Contacts By Business Id — response body — contacts item custom Fields item, Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website dnd Settings call, email, fb, gmb, sms, whats App

Get Contacts By Business Id — response body — contacts item attributions item

Field	Type	Presence	Description and constraints
$	object	Root
campaign	JSON	Optional
campaign (anyOf 1)	string	Alternative	Campaign name
campaign (anyOf 2)	null	Alternative
campaignId	JSON	Optional
campaignId (anyOf 1)	string	Alternative	Campaign Id
campaignId (anyOf 2)	null	Alternative
dclid	JSON	Optional
dclid (anyOf 1)	string	Alternative	DoubleClick click Id
dclid (anyOf 2)	null	Alternative
fbEventId	JSON	Optional
fbEventId (anyOf 1)	string	Alternative	Facebook event Id
fbEventId (anyOf 2)	null	Alternative
fbc	JSON	Optional
fbc (anyOf 1)	string	Alternative	Facebook browser Id
fbc (anyOf 2)	null	Alternative
fbclid	JSON	Optional
fbclid (anyOf 1)	string	Alternative	Facebook click Id
fbclid (anyOf 2)	null	Alternative
fbp	JSON	Optional
fbp (anyOf 1)	string	Alternative	Facebook pixel Id
fbp (anyOf 2)	null	Alternative
gclid	JSON	Optional
gclid (anyOf 1)	string	Alternative	Google click Id
gclid (anyOf 2)	null	Alternative
ip	JSON	Optional
ip (anyOf 1)	string	Alternative	IP address of the visitor
ip (anyOf 2)	null	Alternative
medium	JSON	Optional
medium (anyOf 1)	string	Alternative	Attribution medium (e.g. survey, funnel)
medium (anyOf 2)	null	Alternative
mediumId	JSON	Optional
mediumId (anyOf 1)	string	Alternative	Id of the attribution medium
mediumId (anyOf 2)	null	Alternative
msclikid	JSON	Optional
msclikid (anyOf 1)	string	Alternative	Microsoft click Id
msclikid (anyOf 2)	null	Alternative
referrer	JSON	Optional
referrer (anyOf 1)	string	Alternative	Referrer URL
referrer (anyOf 2)	null	Alternative
url	string	Required within parent	Attribution source type
userAgent	JSON	Optional
userAgent (anyOf 1)	string	Alternative	Browser user agent string
userAgent (anyOf 2)	null	Alternative
utmContent	JSON	Optional
utmContent (anyOf 1)	string	Alternative	UTM content parameter
utmContent (anyOf 2)	null	Alternative
utmMedium	JSON	Optional
utmMedium (anyOf 1)	string	Alternative	UTM medium parameter
utmMedium (anyOf 2)	null	Alternative
utmSource	JSON	Optional
utmSource (anyOf 1)	string	Alternative	UTM source parameter
utmSource (anyOf 2)	null	Alternative

Get Contacts By Business Id — response body — contacts item custom Fields item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Unique identifier of the custom field
value	string	Optional	Value of the custom field

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_contact. Catalog operation: 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: ["contacts.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source