HighLevel: Companies schemas

← Companies operations · All schemas

Get Company — response body

Field	Type	Presence	Description and constraints
$	object	Root
company	Model	Optional	Expand Get Company — response body — company

Referenced models: Get Company — response body — company

Get Company — response body — company

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional
affiliatePolicyAcceptedBy	string	Optional
affiliatePolicyAcceptedDate	string	Optional
affiliatePolicyVersion	string	Optional
autoSuspendEnabled	boolean	Optional	Flag to set if auto suspend is enabled
businessAffinityGroup	string	Optional	The affinity group of the agency
businessCategory	string	Optional	Business category
businessNiche	string	Optional	The business niche in which the agency is operating
cancelEnabledForClients	boolean	Optional	Flag to set if cancel plan is enabled
city	string	Optional
country	string	Optional
currency	string	Optional
customerType	string	Optional
disableEmailService	boolean	Optional
domain	string	Optional
email	string	Optional
enableDepreciatedFeatures	boolean	Optional
enableNewSubAccountDefaultData	boolean	Optional	Flag to determine if new sub-accounts should use default data
id	string	Optional
isEnterpriseAccount	boolean	Optional
isReselling	boolean	Optional
isSandboxAccount	boolean	Optional
locationCount	JSON	Optional
locationCount (anyOf 1)	number	Alternative
locationCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
logoUrl	string	Optional
name	string	Optional
onboardingInfo	JSON	Optional
onboardingInfo (allOf 1)	Model	All variants apply	Expand Get Company — response body — company onboarding Info affiliate Signup, conversation Demo, customer Count, has Joined Implementation Call, has Joined Kickoff Call, have Website, industry Served, kickoff Action Taken, location, location Id, meta Data, pending, plan Id, snapshot Id, tools, version, website Url
phone	string	Optional
plan	JSON	Optional
plan (anyOf 1)	number	Alternative
plan (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
postalCode	string	Optional
premiumUpgraded	boolean	Optional	If you want to enable / disable Priority Support for any agency. Default value is false. Default: false
privacyPolicy	string	Optional
privacyPolicyAcceptedBy	string	Optional
privacyPolicyAcceptedDate	string	Optional
privacyPolicyVersion	string	Optional
referralId	string	Optional
relationshipNumber	string	Optional
saasSettings	object	Optional	Saas Settings
spareDomain	string	Optional
state	string	Optional
status	string	Optional
stripeConnectId	string	Optional
subdomain	string	Optional
termsConditions	string	Optional
termsOfServiceAcceptedBy	string	Optional
termsOfServiceAcceptedDate	string	Optional
termsOfServiceVersion	string	Optional
timezone	string	Optional
twilioFreeCredits	JSON	Optional
twilioFreeCredits (anyOf 1)	number	Alternative
twilioFreeCredits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
twilioTrialMode	boolean	Optional
upgradeEnabledForClients	boolean	Optional	Flag to set if upgrade plan is enabled
website	string	Optional

Referenced models: Get Company — response body — company onboarding Info affiliate Signup, conversation Demo, customer Count, has Joined Implementation Call, has Joined Kickoff Call, have Website, industry Served, kickoff Action Taken, location, location Id, meta Data, pending, plan Id, snapshot Id, tools, version, website Url

Get Company — response body — company onboarding Info affiliate Signup, conversation Demo, customer Count, has Joined Implementation Call, has Joined Kickoff Call, have Website, industry Served, kickoff Action Taken, location, location Id, meta Data, pending, plan Id, snapshot Id, tools, version, website Url

Field	Type	Presence	Description and constraints
$	object	Root
affiliateSignup	boolean	Optional	Set to true if it is from affiliate
conversationDemo	boolean	Optional
customerCount	string	Optional
hasJoinedImplementationCall	boolean	Optional	Set to true if user joined implementation call
hasJoinedKickoffCall	boolean	Optional	Set to true if user joined onboarding call
haveWebsite	boolean	Optional
industryServed	string	Optional
kickoffActionTaken	boolean	Optional	Set to true if user joined onboarding call
location	boolean	Optional
locationId	string	Optional
metaData	object	Optional	metaData for onboarding
pending	boolean	Required within parent
planId	string	Optional	Selected agency plan unique plan Id
snapshotId	string	Optional
tools	array	Optional
tools[]	string	Each item
version	string	Optional	This helps in A/B tracking of onboarding flow
websiteUrl	string	Optional