Request
Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Use the Access Token generated with user type as Agency.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Path Parameters
companyId
stringExamples:
ve9EPM428h8vShlRW1KT
Headers
Authorization
string
Access Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
API Version
Allowed value:
2021-07-28
Responses
200
Successful response
Body
company
object
id
string
Example:
seD4PfOuKoVMLkEZqohJ
name
string
Example:
Tesla inc
email
string
Example:
john@deo.com
logoUrl
string
Example:
https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873
phone
string
Example:
+1202-555-0107
website
string
Example:
https://www.tesla.com
domain
string
Example:
https://app.myawesomedomain.com
spareDomain
string
Example:
link.msgsndr.com
privacyPolicy
string
Example:
https://app.gohighlevel.com/privacy_policy
termsConditions
string
Example:
https://app.gohighlevel.com/terms-of-service
theme
string
Example:
default-dark-v1
address
string
Example:
3500 Deer Creek Road
city
string
Example:
Palo Alto
postalCode
string
Example:
94304
country
string
Example:
US
state
string
Example:
CA
timezone
string
Example:
US/Central
relationshipNumber
string
Example:
x-xxx-xxx
faviconUrl
string
Example:
https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873
subdomain
string
Example:
https://app.myawesomedomain.com/subdomain
plan
number
Example:
1
currency
string
Example:
customerType
string
Example:
agency
termsOfServiceVersion
string
Example:
06/01/2022
termsOfServiceAcceptedBy
string
Example:
SDfdf355Dfggdee
twilioTrialMode
boolean
Example:
true
twilioFreeCredits
number
Example:
100
termsOfServiceAcceptedDate
string
Example:
privacyPolicyVersion
string
Example:
06/01/2022
privacyPolicyAcceptedBy
string
Example:
SDfdf355Dfggdee
privacyPolicyAcceptedDate
string
Example:
affiliatePolicyVersion
string
Example:
06/01/2022
affiliatePolicyAcceptedBy
string
Example:
SDfdf355Dfggdee
affiliatePolicyAcceptedDate
string
Example:
isReselling
boolean
Example:
true
onboardingInfo
object
Example:
stripeId
string
Example:
upgradeEnabledForClients
boolean
Flag to set if upgrade plan is enabled
Example:
true
cancelEnabledForClients
boolean
Flag to set if cancel plan is enabled
Example:
true
autoSuspendEnabled
boolean
Flag to set if auto suspend is enabled
Example:
true
saasSettings
object
Saas Settings
Example:
{"agencyDashboardVisibleTo":"string","stripeConnectInitiatedBy":"string"}
stripeActivePlan
string
Example:
agency_monthly_297
stripeConnectId
string
Example:
enableDepreciatedFeatures
boolean
Example:
true
premiumUpgraded
boolean
If you want to enable / disable Priority Support for any agency. Default value is false.
Default:
false
Example:
false
status
string
Example:
active-trial
locationCount
number
Example:
10
disableEmailService
boolean
Example:
false
billingInfo
object
422
Unprocessable Entity
Body
statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
401
Unauthorized
Body
statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
400
Bad Request
Body
statusCode
number
Example:
400
message
string
Example:
Bad Request