CompaniesVersion: v3
Get Company
GET/companies/{companyId}
Get Comapny
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
companies.Auth methods:
OAuthPrivate IntegrationToken type:
Agency TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Path Parameters
companyIdstringrequired
Example:
ve9EPM428h8vShlRW1KTResponse
application/json
Successful response
companyobject
company.idstring
Example:
seD4PfOuKoVMLkEZqohJcompany.namestring
Example:
Tesla inccompany.emailstring
Example:
[email protected]company.logoUrlstring
Example:
https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873company.phonestring
Example:
+1202-555-0107company.websitestring
Example:
https://www.tesla.comcompany.domainstring
Example:
https://app.myawesomedomain.comcompany.spareDomainstring
Example:
link.msgsndr.comcompany.privacyPolicystring
Example:
https://app.gohighlevel.com/privacy_policycompany.termsConditionsstring
Example:
https://app.gohighlevel.com/terms-of-servicecompany.addressstring
Example:
3500 Deer Creek Roadcompany.citystring
Example:
Palo Altocompany.postalCodestring
Example:
94304company.countrystring
Example:
UScompany.statestring
Example:
CAcompany.timezonestring
Example:
US/Centralcompany.relationshipNumberstring
Example:
x-xxx-xxxcompany.subdomainstring
Example:
https://app.myawesomedomain.com/subdomaincompany.plannumber
Example:
1company.currencystring
Example:
company.customerTypestring
Example:
agencycompany.termsOfServiceVersionstring
Example:
06/01/2022company.termsOfServiceAcceptedBystring
Example:
SDfdf355Dfggdeecompany.twilioTrialModeboolean
Example:
truecompany.twilioFreeCreditsnumber
Example:
100company.termsOfServiceAcceptedDatestring
Example:
company.privacyPolicyVersionstring
Example:
06/01/2022company.privacyPolicyAcceptedBystring
Example:
SDfdf355Dfggdeecompany.privacyPolicyAcceptedDatestring
Example:
company.affiliatePolicyVersionstring
Example:
06/01/2022company.affiliatePolicyAcceptedBystring
Example:
SDfdf355Dfggdeecompany.affiliatePolicyAcceptedDatestring
Example:
company.isResellingboolean
Example:
truecompany.onboardingInfoobject
company.onboardingInfo.pendingbooleanrequired
Example:
truecompany.onboardingInfo.haveWebsiteboolean
Example:
company.onboardingInfo.websiteUrlstring
Example:
company.onboardingInfo.industryServedstring
Example:
company.onboardingInfo.customerCountstring
Example:
company.onboardingInfo.toolsstring[]
Example:
company.onboardingInfo.locationboolean
Example:
company.onboardingInfo.conversationDemoboolean
Example:
company.onboardingInfo.locationIdstring
Example:
company.onboardingInfo.snapshotIdstring
Example:
company.onboardingInfo.planIdstring
Selected agency plan unique plan Id
Example:
plan_EOi37NLV12u68icompany.onboardingInfo.affiliateSignupboolean
Set to true if it is from affiliate
Example:
truecompany.onboardingInfo.hasJoinedKickoffCallboolean
Set to true if user joined onboarding call
Example:
truecompany.onboardingInfo.kickoffActionTakenboolean
Set to true if user joined onboarding call
Example:
truecompany.onboardingInfo.hasJoinedImplementationCallboolean
Set to true if user joined implementation call
Example:
truecompany.onboardingInfo.versionstring
This helps in A/B tracking of onboarding flow
Example:
1company.onboardingInfo.metaDataobject
metaData for onboarding
Example:
truecompany.upgradeEnabledForClientsboolean
Flag to set if upgrade plan is enabled
Example:
truecompany.cancelEnabledForClientsboolean
Flag to set if cancel plan is enabled
Example:
truecompany.autoSuspendEnabledboolean
Flag to set if auto suspend is enabled
Example:
truecompany.saasSettingsobject
Saas Settings
company.stripeConnectIdstring
Example:
company.enableDepreciatedFeaturesboolean
Example:
truecompany.premiumUpgradedboolean
If you want to enable / disable Priority Support for any agency. Default value is false.
Default:
falseExample:
falsecompany.statusstring
Example:
active-trialcompany.locationCountnumber
Example:
10company.disableEmailServiceboolean
Example:
falsecompany.referralIdstring
Example:
john-doe-21company.isEnterpriseAccountboolean
Example:
truecompany.businessNichestring
The business niche in which the agency is operating
Example:
Accounting Schoolcompany.businessCategorystring
Business category
Example:
Automotivecompany.businessAffinityGroupstring
The affinity group of the agency
Example:
Vehicle Dealershipscompany.isSandboxAccountboolean
Example:
truecompany.enableNewSubAccountDefaultDataboolean
Flag to determine if new sub-accounts should use default data
Example:
false