Skip to content

Businesses.md

Latest commit

 

History

History
1583 lines (986 loc) · 22.5 KB

Businesses.md

File metadata and controls

1583 lines (986 loc) · 22.5 KB

Businesses API

Source: HighLevel API 2.0 Documentation Crawled: 2026-03-25

Table of Contents

Businesses

Source: https://marketplace.gohighlevel.com/docs/ghl/businesses/businesses

Skip to main content

Documentation for business API

📄️ Update Business \ Update Business📄️ Delete Business \ Delete Business📄️ Get Business \ Get Business📄️ Get Businesses by Location \ Get Businesses by Location📄️ Create Business \ Create Business

Business Api

Source: https://marketplace.gohighlevel.com/docs/ghl/businesses/business-api

Skip to main content

Version: 1.0

Business API

Documentation for business API

Authentication ​

  • HTTP: Bearer Auth
  • HTTP: Bearer Auth
  • HTTP: Bearer Auth
  • HTTP: Bearer Auth

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Create Business

Source: https://marketplace.gohighlevel.com/docs/ghl/businesses/create-business

Skip to main content

Create Business

POST https://services.leadconnectorhq.com/businesses/

Create Business

Requirements

Scope(s)

businesses.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

  • application/json

Body required

name stringrequired

Example:Microsoft

locationId stringrequired

Example:5DP4iH6HLkQsiKESj6rh

phone string

Example:+18832327657

email string

Example:john@deo.com

website string

Example:www.xyz.com

address string

Example:street adress

city string

Example:new york

postalCode string

Example:12312312

state string

Example:new york

country string

Example:us

description string

Example:business description

Responses ​

  • 201
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

success booleanrequired

Success Value

Example:true

buiseness object

Business Response

id stringrequired

Business Id

Example:63771dcac1116f0e21de8e12

name stringrequired

Business Name

Example:Microsoft

phone string

phone number

email string

email

Example:abc@microsoft.com

website string

website

Example:microsoft.com

address string

address

city string

city

description string

description

state string

state

postalCode string

postal code

country string

country

Example:united states

updatedBy object

updated By

locationId stringrequired

locaitonId

createdBy object

Created By

createdAt date-time

Creation Time

updatedAt date-time

Last updation time

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

Authorization: Authorization

name: Authorizationtype: httpscopes: businesses.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/businesses/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "Microsoft",
  "locationId": "5DP4iH6HLkQsiKESj6rh",
  "phone": "+18832327657",
  "email": "john@deo.com",
  "website": "www.xyz.com",
  "address": "street adress",
  "city": "new york",
  "postalCode": "12312312",
  "state": "new york",
  "country": "us",
  "description": "business description"
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

Version — headerrequired

---2021-07-28

Body required

{
  "name": "Microsoft",
  "locationId": "5DP4iH6HLkQsiKESj6rh",
  "phone": "+18832327657",
  "email": "john@deo.com",
  "website": "www.xyz.com",
  "address": "street adress",
  "city": "new york",
  "postalCode": "12312312",
  "state": "new york",
  "country": "us",
  "description": "business description"
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Delete Business

Source: https://marketplace.gohighlevel.com/docs/ghl/businesses/delete-business

Skip to main content

Delete Business

DELETE https://services.leadconnectorhq.com/businesses/:businessId

Delete Business

Requirements

Scope(s)

businesses.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

businessId stringrequired

Example: 5DP4iH6HLkQsiKESj6rh

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

success booleanrequired

Success value

Example:true

{
  "success": true
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: businesses.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X DELETE 'https://services.leadconnectorhq.com/businesses/:businessId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

businessId — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Business

Source: https://marketplace.gohighlevel.com/docs/ghl/businesses/get-business

Skip to main content

Get Business

GET https://services.leadconnectorhq.com/businesses/:businessId

Get Business

Requirements

Scope(s)

businesses.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

businessId stringrequired

Example: 5DP4iH6HLkQsiKESj6rh

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

business object

Business Response

id stringrequired

Business Id

Example:63771dcac1116f0e21de8e12

name stringrequired

Business Name

Example:Microsoft

phone string

phone number

email string

email

Example:abc@microsoft.com

website string

website

Example:microsoft.com

address string

address

city string

city

description string

description

state string

state

postalCode string

postal code

country string

country

Example:united states

updatedBy object

updated By

locationId stringrequired

locaitonId

createdBy object

Created By

createdAt date-time

Creation Time

updatedAt date-time

Last updation time

{
  "business": {
    "id": "63771dcac1116f0e21de8e12",
    "name": "Microsoft",
    "phone": "string",
    "email": "abc@microsoft.com",
    "website": "microsoft.com",
    "address": "string",
    "city": "string",
    "description": "string",
    "state": "string",
    "postalCode": "string",
    "country": "united states",
    "updatedBy": {},
    "locationId": "string",
    "createdBy": {},
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: businesses.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/businesses/:businessId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

businessId — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Businesses By Location

Source: https://marketplace.gohighlevel.com/docs/ghl/businesses/get-businesses-by-location

Skip to main content

Get Businesses by Location

GET https://services.leadconnectorhq.com/businesses/

Get Businesses by Location

Requirements

Scope(s)

businesses.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Query Parameters

locationId stringrequired

Example: 5DP4iH6HLkQsiKESj6rh

limit string

Default value:100

Example: 100

skip string

Default value:0

Example: 10

Responses ​

  • 200
  • 400
  • 401

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

businesses object[]required

Business Response

Array [

id stringrequired

Business Id

Example:63771dcac1116f0e21de8e12

name stringrequired

Business Name

Example:Microsoft

phone string

phone number

email string

email

Example:abc@microsoft.com

website string

website

Example:microsoft.com

address string

address

city string

city

description string

description

state string

state

postalCode string

postal code

country string

country

Example:united states

updatedBy object

updated By

locationId stringrequired

locaitonId

createdBy object

Created By

createdAt date-time

Creation Time

updatedAt date-time

Last updation time

]

{
  "businesses": [\
    {\
      "id": "63771dcac1116f0e21de8e12",\
      "name": "Microsoft",\
      "phone": "string",\
      "email": "abc@microsoft.com",\
      "website": "microsoft.com",\
      "address": "string",\
      "city": "string",\
      "description": "string",\
      "state": "string",\
      "postalCode": "string",\
      "country": "united states",\
      "updatedBy": {},\
      "locationId": "string",\
      "createdBy": {},\
      "createdAt": "2024-07-29T15:51:28.071Z",\
      "updatedAt": "2024-07-29T15:51:28.071Z"\
    }\
  ]
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: businesses.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/businesses/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — queryrequired

Version — headerrequired

---2021-07-28

Show optional parameters

limit — query

skip — query

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Update Business

Source: https://marketplace.gohighlevel.com/docs/ghl/businesses/update-business

Skip to main content

Update Business

PUT https://services.leadconnectorhq.com/businesses/:businessId

Update Business

Requirements

Scope(s)

businesses.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

businessId stringrequired

Example: 5DP4iH6HLkQsiKESj6rh

  • application/json

Body required

name string

Example:Microsoft

phone string

Example:+18832327657

email string

Example:john@deo.com

postalCode string

Example:12312312

website string

Example:www.xyz.com

address string

Example:street adress

state string

Example:new york

city string

Example:new york

country string

Example:us

description string

Example:business description

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

success booleanrequired

Success Value

Example:true

buiseness object

Business Response

id stringrequired

Business Id

Example:63771dcac1116f0e21de8e12

name stringrequired

Business Name

Example:Microsoft

phone string

phone number

email string

email

Example:abc@microsoft.com

website string

website

Example:microsoft.com

address string

address

city string

city

description string

description

state string

state

postalCode string

postal code

country string

country

Example:united states

updatedBy object

updated By

locationId stringrequired

locaitonId

createdBy object

Created By

createdAt date-time

Creation Time

updatedAt date-time

Last updation time

{
  "success": true,
  "buiseness": {
    "id": "63771dcac1116f0e21de8e12",
    "name": "Microsoft",
    "phone": "string",
    "email": "abc@microsoft.com",
    "website": "microsoft.com",
    "address": "string",
    "city": "string",
    "description": "string",
    "state": "string",
    "postalCode": "string",
    "country": "united states",
    "updatedBy": {},
    "locationId": "string",
    "createdBy": {},
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: businesses.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X PUT 'https://services.leadconnectorhq.com/businesses/:businessId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "Microsoft",
  "phone": "+18832327657",
  "email": "john@deo.com",
  "postalCode": "12312312",
  "website": "www.xyz.com",
  "address": "street adress",
  "state": "new york",
  "city": "new york",
  "country": "us",
  "description": "business description"
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

businessId — pathrequired

Version — headerrequired

---2021-07-28

Body required

{
  "name": "Microsoft",
  "phone": "+18832327657",
  "email": "john@deo.com",
  "postalCode": "12312312",
  "website": "www.xyz.com",
  "address": "street adress",
  "state": "new york",
  "city": "new york",
  "country": "us",
  "description": "business description"
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!