urieljareth/MP-Manager

Fork 0

Files

T

urieljareth a35d26fac0 Primer commit

2026-05-30 14:31:19 -06:00

17 KiB

Raw Permalink Blame History

GHL Businesses API

Endpoints: 5 Base URL: https://rest.gohighlevel.com/v1

Version Header(s): 2021-07-28

Endpoints

GET /businesses/ — Get Businesses by Location
POST /businesses/ — Create Business
DELETE /businesses/{businessId} — Delete Business
GET /businesses/{businessId} — Get Business
PUT /businesses/{businessId} — Update Business

GET /businesses/

Summary: Get Businesses by Location

Get Businesses by Location

Version Header: 2021-07-28

Operation ID: get-businesses-by-location

Tags: Businesses

cURL

curl -X GET 'https://rest.gohighlevel.com/v1/businesses/?locationId=5DP4iH6HLkQsiKESj6rh&limit=100&skip=10' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: YourApp/1.0'

Python (http.client)

import http.client
import json

conn = http.client.HTTPSConnection('rest.gohighlevel.com')

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Version': '2021-07-28',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'User-Agent': 'YourApp/1.0',
}

conn.request('GET', '/v1/businesses/?locationId=5DP4iH6HLkQsiKESj6rh&limit=100&skip=10', headers=headers)

response = conn.getresponse()
data = json.loads(response.read().decode())
print(json.dumps(data, indent=2))
conn.close()

n8n HTTP Node

{
  "name": "GHL - GET businesses",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "GET",
    "url": "https://rest.gohighlevel.com/v1/businesses/",
    "authentication": "genericCredentialType",
    "genericAuthType": "httpHeaderAuth",
    "sendHeaders": true,
    "headerParameters": {
      "parameters": [
        {
          "name": "Authorization",
          "value": "Bearer YOUR_API_TOKEN"
        },
        {
          "name": "Version",
          "value": "2021-07-28"
        },
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Accept",
          "value": "application/json"
        },
        {
          "name": "User-Agent",
          "value": "YourApp/1.0"
        }
      ]
    },
    "sendBody": false,
    "bodyParameters": {
      "parameters": []
    },
    "options": {},
    "sendQuery": true,
    "queryParameters": {
      "parameters": [
        {
          "name": "locationId",
          "value": "5DP4iH6HLkQsiKESj6rh"
        },
        {
          "name": "limit",
          "value": "100"
        },
        {
          "name": "skip",
          "value": "10"
        }
      ]
    }
  }
}

To use in n8n:

Add an HTTP Request node
Switch to JSON mode (Parameters → use RAW JSON)
Paste the JSON above
Update YOUR_API_TOKEN with your actual GHL API key

Request Parameters

Name	Location	Type	Required	Description
`locationId`	Query	`string`	✅	[example: `5DP4iH6HLkQsiKESj6rh`]
`limit`	Query	`string`	—	[example: `100`]
`skip`	Query	`string`	—	[example: `10`]

Response Codes

Code	Description	Schema
`200`	Successful response	- businesses (array of BusinessDto) (required): Business Response
`400`	Bad Request	Standard error response for bad requests (400). Contains message, statusCode fields.
`401`	Unauthorized	Standard error response for unauthorized requests (401). Contains message, statusCode fields.

⚠️ Special Notes & Quirks

⚠️ User-Agent Required: All GHL API requests require a User-Agent HTTP header. Requests without it may be rejected with a 403 error.

POST /businesses/

Summary: Create Business

Create Business

Version Header: 2021-07-28

Operation ID: create-business

Tags: Businesses

cURL

curl -X POST 'https://rest.gohighlevel.com/v1/businesses/' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: YourApp/1.0' \
  -d '{}'  # See request body schema below

Python (http.client)

import http.client
import json

conn = http.client.HTTPSConnection('rest.gohighlevel.com')

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Version': '2021-07-28',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'User-Agent': 'YourApp/1.0',
}

payload = json.dumps({})
conn.request('POST', '/v1/businesses/', body=payload, headers=headers)

response = conn.getresponse()
data = json.loads(response.read().decode())
print(json.dumps(data, indent=2))
conn.close()

n8n HTTP Node

{
  "name": "GHL - POST businesses",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "POST",
    "url": "https://rest.gohighlevel.com/v1/businesses/",
    "authentication": "genericCredentialType",
    "genericAuthType": "httpHeaderAuth",
    "sendHeaders": true,
    "headerParameters": {
      "parameters": [
        {
          "name": "Authorization",
          "value": "Bearer YOUR_API_TOKEN"
        },
        {
          "name": "Version",
          "value": "2021-07-28"
        },
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Accept",
          "value": "application/json"
        },
        {
          "name": "User-Agent",
          "value": "YourApp/1.0"
        }
      ]
    },
    "sendBody": true,
    "bodyParameters": {
      "parameters": []
    },
    "options": {}
  }
}

To use in n8n:

Add an HTTP Request node
Switch to JSON mode (Parameters → use RAW JSON)
Paste the JSON above
Update YOUR_API_TOKEN with your actual GHL API key

Request Body Schema

name (string) (required) (e.g. Microsoft)
locationId (string) (required) (e.g. 5DP4iH6HLkQsiKESj6rh)
phone (string) (e.g. +18832327657)
email (string) (e.g. john@deo.com)
website (string) (e.g. www.xyz.com)
address (string) (e.g. street adress)
city (string) (e.g. new york)
postalCode (string) (e.g. 12312312)
state (string) (e.g. new york)
country (string) (e.g. us)
description (string) (e.g. business description)

Response Codes

Code	Description	Schema
`201`	Successful response	- success (boolean) (required) (e.g. `True`): Success Value - buiseness (string) (required): Business Response
`400`	Bad Request	Standard error response for bad requests (400). Contains message, statusCode fields.
`401`	Unauthorized	Standard error response for unauthorized requests (401). Contains message, statusCode fields.
`422`	Unprocessable Entity	Standard error response for unprocessable entity (422). Contains message, statusCode, errors array fields.

⚠️ Special Notes & Quirks

⚠️ User-Agent Required: All GHL API requests require a User-Agent HTTP header. Requests without it may be rejected with a 403 error.

DELETE /businesses/{businessId}

Summary: Delete Business

Delete Business

Version Header: 2021-07-28

Operation ID: delete-Business

Tags: Businesses

cURL

curl -X DELETE 'https://rest.gohighlevel.com/v1/businesses/VALUE' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: YourApp/1.0'

Python (http.client)

import http.client
import json

conn = http.client.HTTPSConnection('rest.gohighlevel.com')

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Version': '2021-07-28',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'User-Agent': 'YourApp/1.0',
}

conn.request('DELETE', '/v1/businesses/VALUE', headers=headers)

response = conn.getresponse()
data = json.loads(response.read().decode())
print(json.dumps(data, indent=2))
conn.close()

n8n HTTP Node

{
  "name": "GHL - DELETE VALUE",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "DELETE",
    "url": "https://rest.gohighlevel.com/v1/businesses/VALUE",
    "authentication": "genericCredentialType",
    "genericAuthType": "httpHeaderAuth",
    "sendHeaders": true,
    "headerParameters": {
      "parameters": [
        {
          "name": "Authorization",
          "value": "Bearer YOUR_API_TOKEN"
        },
        {
          "name": "Version",
          "value": "2021-07-28"
        },
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Accept",
          "value": "application/json"
        },
        {
          "name": "User-Agent",
          "value": "YourApp/1.0"
        }
      ]
    },
    "sendBody": false,
    "bodyParameters": {
      "parameters": []
    },
    "options": {}
  }
}

To use in n8n:

Add an HTTP Request node
Switch to JSON mode (Parameters → use RAW JSON)
Paste the JSON above
Update YOUR_API_TOKEN with your actual GHL API key

Request Parameters

Name	Location	Type	Required	Description
`businessId`	Path	`string`	✅

Response Codes

Code	Description	Schema
`200`	Successful response	- success (boolean) (required) (e.g. `True`): Success value
`400`	Bad Request	Standard error response for bad requests (400). Contains message, statusCode fields.
`401`	Unauthorized	Standard error response for unauthorized requests (401). Contains message, statusCode fields.
`422`	Unprocessable Entity	Standard error response for unprocessable entity (422). Contains message, statusCode, errors array fields.

⚠️ Special Notes & Quirks

⚠️ User-Agent Required: All GHL API requests require a User-Agent HTTP header. Requests without it may be rejected with a 403 error.

GET /businesses/{businessId}

Summary: Get Business

Get Business

Version Header: 2021-07-28

Operation ID: get-business

Tags: Businesses

cURL

curl -X GET 'https://rest.gohighlevel.com/v1/businesses/VALUE' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: YourApp/1.0'

Python (http.client)

import http.client
import json

conn = http.client.HTTPSConnection('rest.gohighlevel.com')

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Version': '2021-07-28',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'User-Agent': 'YourApp/1.0',
}

conn.request('GET', '/v1/businesses/VALUE', headers=headers)

response = conn.getresponse()
data = json.loads(response.read().decode())
print(json.dumps(data, indent=2))
conn.close()

n8n HTTP Node

{
  "name": "GHL - GET VALUE",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "GET",
    "url": "https://rest.gohighlevel.com/v1/businesses/VALUE",
    "authentication": "genericCredentialType",
    "genericAuthType": "httpHeaderAuth",
    "sendHeaders": true,
    "headerParameters": {
      "parameters": [
        {
          "name": "Authorization",
          "value": "Bearer YOUR_API_TOKEN"
        },
        {
          "name": "Version",
          "value": "2021-07-28"
        },
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Accept",
          "value": "application/json"
        },
        {
          "name": "User-Agent",
          "value": "YourApp/1.0"
        }
      ]
    },
    "sendBody": false,
    "bodyParameters": {
      "parameters": []
    },
    "options": {}
  }
}

To use in n8n:

Add an HTTP Request node
Switch to JSON mode (Parameters → use RAW JSON)
Paste the JSON above
Update YOUR_API_TOKEN with your actual GHL API key

Request Parameters

Name	Location	Type	Required	Description
`businessId`	Path	`string`	✅

Response Codes

Code	Description	Schema
`200`	Successful response	- business (string) (required): Business Response
`400`	Bad Request	Standard error response for bad requests (400). Contains message, statusCode fields.
`401`	Unauthorized	Standard error response for unauthorized requests (401). Contains message, statusCode fields.
`422`	Unprocessable Entity	Standard error response for unprocessable entity (422). Contains message, statusCode, errors array fields.

⚠️ Special Notes & Quirks

⚠️ User-Agent Required: All GHL API requests require a User-Agent HTTP header. Requests without it may be rejected with a 403 error.

PUT /businesses/{businessId}

Summary: Update Business

Update Business

Version Header: 2021-07-28

Operation ID: update-business

Tags: Businesses

cURL

curl -X PUT 'https://rest.gohighlevel.com/v1/businesses/VALUE' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: YourApp/1.0' \
  -d '{}'  # See request body schema below

Python (http.client)

import http.client
import json

conn = http.client.HTTPSConnection('rest.gohighlevel.com')

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Version': '2021-07-28',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'User-Agent': 'YourApp/1.0',
}

payload = json.dumps({})
conn.request('PUT', '/v1/businesses/VALUE', body=payload, headers=headers)

response = conn.getresponse()
data = json.loads(response.read().decode())
print(json.dumps(data, indent=2))
conn.close()

n8n HTTP Node

{
  "name": "GHL - PUT VALUE",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "PUT",
    "url": "https://rest.gohighlevel.com/v1/businesses/VALUE",
    "authentication": "genericCredentialType",
    "genericAuthType": "httpHeaderAuth",
    "sendHeaders": true,
    "headerParameters": {
      "parameters": [
        {
          "name": "Authorization",
          "value": "Bearer YOUR_API_TOKEN"
        },
        {
          "name": "Version",
          "value": "2021-07-28"
        },
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Accept",
          "value": "application/json"
        },
        {
          "name": "User-Agent",
          "value": "YourApp/1.0"
        }
      ]
    },
    "sendBody": true,
    "bodyParameters": {
      "parameters": []
    },
    "options": {}
  }
}

To use in n8n:

Add an HTTP Request node
Switch to JSON mode (Parameters → use RAW JSON)
Paste the JSON above
Update YOUR_API_TOKEN with your actual GHL API key

Request Parameters

Name	Location	Type	Required	Description
`businessId`	Path	`string`	✅

Request Body Schema

name (string) (e.g. Microsoft)
phone (string) (e.g. +18832327657)
email (string) (e.g. john@deo.com)
postalCode (string) (e.g. 12312312)
website (string) (e.g. www.xyz.com)
address (string) (e.g. street adress)
state (string) (e.g. new york)
city (string) (e.g. new york)
country (string) (e.g. us)
description (string) (e.g. business description)

Response Codes

Code	Description	Schema
`200`	Successful response	- success (boolean) (required) (e.g. `True`): Success Value - buiseness (string) (required): Business Response
`400`	Bad Request	Standard error response for bad requests (400). Contains message, statusCode fields.
`401`	Unauthorized	Standard error response for unauthorized requests (401). Contains message, statusCode fields.
`422`	Unprocessable Entity	Standard error response for unprocessable entity (422). Contains message, statusCode, errors array fields.

⚠️ Special Notes & Quirks

⚠️ User-Agent Required: All GHL API requests require a User-Agent HTTP header. Requests without it may be rejected with a 403 error.

Documentation generated from GHL OpenAPI specifications. Verify against official docs for latest changes.

17 KiB Raw Permalink Blame History

GHL Businesses API

Endpoints

GET /businesses/

cURL

Python (http.client)

n8n HTTP Node

Request Parameters

Response Codes

⚠️ Special Notes & Quirks

POST /businesses/

cURL

Python (http.client)

n8n HTTP Node

Request Body Schema

Response Codes

⚠️ Special Notes & Quirks

DELETE /businesses/{businessId}

cURL

Python (http.client)

n8n HTTP Node

Request Parameters

Response Codes

⚠️ Special Notes & Quirks

GET /businesses/{businessId}

cURL

Python (http.client)

n8n HTTP Node

Request Parameters

Response Codes

⚠️ Special Notes & Quirks

PUT /businesses/{businessId}

cURL

Python (http.client)

n8n HTTP Node

Request Parameters

Request Body Schema

Response Codes

⚠️ Special Notes & Quirks

17 KiB

Raw Permalink Blame History