MP-Manager/n8n/API Docs/categories/objects-api.md

GHL Objects API

⚠️ Schema Discovery: Use GET /objects/{key}?locationId=LOC_ID with Version: 2021-07-28 for schema discovery. Object key for custom objects must include custom_objects. prefix.

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

Version Header(s): 2021-07-28

---

Endpoints

• GET /objects/ — Get all objects for a location
• POST /objects/ — Create Custom Object
• GET /objects/{key} — Get Object Schema by key / id
• PUT /objects/{key} — Update Object Schema By Key / Id
• POST /objects/{schemaKey}/records — Create Record
• POST /objects/{schemaKey}/records/search — Search Object Records
• DELETE /objects/{schemaKey}/records/{id} — Delete Record
• GET /objects/{schemaKey}/records/{id} — Get Record By Id
• PUT /objects/{schemaKey}/records/{id} — Update Record

---

GET /objects/

Summary: Get all objects for a location

Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Version Header: 2021-07-28

📖 Official Documentation

Operation ID: get-object-by-location-id

Tags: Object Schema

cURL

curl -X GET 'https://rest.gohighlevel.com/v1/objects/?locationId=632c34b4c9b7da3358ac9891' \
  -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/objects/?locationId=632c34b4c9b7da3358ac9891', 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 objects",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "GET",
    "url": "https://rest.gohighlevel.com/v1/objects/",
    "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": "632c34b4c9b7da3358ac9891"
        }
      ]
    }
  }
}

To use in n8n:

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

Request Parameters

Name	Location	Type	Required	Description
locationId	Query	string	✅	location id [example: 632c34b4c9b7da3358ac9891]

Response Codes

Code	Description	Schema
200	Successful response	- objects (array of ICustomObjectSchema)
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.

---

POST /objects/

Summary: Create Custom Object

Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Version Header: 2021-07-28

📖 Official Documentation

Operation ID: create-custom-object-schema

Tags: Object Schema

cURL

curl -X POST 'https://rest.gohighlevel.com/v1/objects/' \
  -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/objects/', 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 objects",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "POST",
    "url": "https://rest.gohighlevel.com/v1/objects/",
    "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:

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

Request Body Schema

• labels (string) (required) (e.g. {'singular': 'Pet', 'plural': 'Pets'}): This is what your custom object will be called. These labels will be used to display your custom object on the UI
• key (string) (required) (e.g. custom_objects.pet): key that would be used to refer the Custom Object internally (lowercase + underscore_separated). 'custom_objects.' would be added as prefix by default
• description (string) (e.g. These are non vaccinated pets): Pet Object`s description
• locationId (string) (required) (e.g. ve9EPM428h8vShlRW1KT): Location Id
• primaryDisplayPropertyDetails (string) (required): Primary property which will be displayed on the record page

Response Codes

Code	Description	Schema
201	Successful response	- object (ICustomObjectSchema)
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 /objects/{key}

Summary: Get Object Schema by key / id

Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Version Header: 2021-07-28

📖 Official Documentation

Operation ID: get-object-schema-by-key

Tags: Object Schema

cURL

curl -X GET 'https://rest.gohighlevel.com/v1/objects/custom_objects.pet?locationId=632c34b4c9b7da3358ac9891&fetchProperties=True' \
  -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/objects/custom_objects.pet?locationId=632c34b4c9b7da3358ac9891&fetchProperties=True', 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 custom_objects.pet",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "GET",
    "url": "https://rest.gohighlevel.com/v1/objects/custom_objects.pet",
    "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": "632c34b4c9b7da3358ac9891"
        },
        {
          "name": "fetchProperties",
          "value": true
        }
      ]
    }
  }
}

To use in n8n:

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

Request Parameters

Name	Location	Type	Required	Description
key	Path	string	✅	key of the custom or standard object. For custom objects, the key must include the prefix “custom...
locationId	Query	string	✅	location id of the sub account [example: 632c34b4c9b7da3358ac9891]
fetchProperties	Query	string	—	Fetch Properties , Fetches all the standard / custom fields of the object when set to true [examp...

Response Codes

Code	Description	Schema
200	Successful response	- object (ICustomObjectSchema) - cache (boolean) (required) (e.g. True): Is the response served from cache - fields (array of I...
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.

📌 Schema Discovery: Use this endpoint with locationId query parameter to discover custom fields for any object type (contact, opportunity, etc.). Always call this first before updating fields to get the correct field IDs.

---

PUT /objects/{key}

Summary: Update Object Schema By Key / Id

Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Version Header: 2021-07-28

📖 Official Documentation

Operation ID: update-custom-object

Tags: Object Schema

cURL

curl -X PUT 'https://rest.gohighlevel.com/v1/objects/custom_objects.pet' \
  -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/objects/custom_objects.pet', 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 custom_objects.pet",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "PUT",
    "url": "https://rest.gohighlevel.com/v1/objects/custom_objects.pet",
    "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:

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

Request Parameters

Name	Location	Type	Required	Description
key	Path	string	✅	key of the custom or standard object. For custom objects, the key must include the prefix “custom...

Request Body Schema

• labels (string) (e.g. {'singular': 'Pet', 'plural': 'Pets'}): This is how your custom object will be displayed
• description (string) (e.g. These are non vaccinated pets): Pet Object`s description
• locationId (string) (required) (e.g. 632c34b4c9b7da3358ac9891): location id
• searchableProperties (array) (required) (e.g. ['custom_objects.mad.mad', 'custom_objects.mad.record_1', 'custom_objects.mad.nn']): Searchable Fields: Provide the field key of your object that you want to search on, using the format (custom_object.<object_name>.<field_key>).

Response Codes

Code	Description	Schema
200	Successful response	- object (ICustomObjectSchema)
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.

---

POST /objects/{schemaKey}/records

Summary: Create Record

Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

Version Header: 2021-07-28

📖 Official Documentation

Operation ID: create-object-record

Tags: Records

cURL

curl -X POST 'https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records' \
  -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/objects/custom_objects.pet or business.email (for company's email)/records', 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 records",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "POST",
    "url": "https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records",
    "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:

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

Request Parameters

Name	Location	Type	Required	Description
schemaKey	Path	string	✅	The key of the Custom Object / Standard Object Schema. For custom objects, the key must include t...

Request Body Schema

object — no documented properties

Response Codes

Code	Description	Schema
201	Successful response	- record (IRecordSchema)
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 /objects/{schemaKey}/records/search

Summary: Search Object Records

Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336

Version Header: 2021-07-28

Operation ID: search-object-records

Tags: Search Object Records

cURL

curl -X POST 'https://rest.gohighlevel.com/v1/objects/632c34b4c9b7da3358ac9891/records/search' \
  -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/objects/632c34b4c9b7da3358ac9891/records/search', 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 search",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "POST",
    "url": "https://rest.gohighlevel.com/v1/objects/632c34b4c9b7da3358ac9891/records/search",
    "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:

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

Request Parameters

Name	Location	Type	Required	Description
schemaKey	Path	string	—	custom object key [example: 632c34b4c9b7da3358ac9891]

Request Body Schema

• locationId (string) (required) (e.g. ve9EPM428h8vShlRW1KT): Location Id
• page (number) (required) (e.g. 1): Page
• pageLimit (number) (required) (e.g. 10): Page Limit
• query (string) (required) (e.g. Buddy): Pass this query parameter to search using your searchable properties. For example, if you have a custom object called “Pets” and have configured “name” as a searchable property, you can pass name:Buddy to search for pets with the name “Buddy.”
• searchAfter (array) (required) (e.g. ['sx6wyHhbFdRXh302Lunr', 'sx6wyHhbFdRXh302Lunr'])

Response Codes

Code	Description	Schema
200	Successful response	- records (array of RecordResponseDTO): Records - total (number) (required) (e.g. 20): Total Number of records
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 for Search: Search endpoints use POST instead of GET because the search filters are complex JSON objects that can't be easily encoded in query parameters.

---

DELETE /objects/{schemaKey}/records/{id}

Summary: Delete Record

Delete Record By Id . Supported Objects are business and custom objects.

Version Header: 2021-07-28

Operation ID: delete-object-record

Tags: Records

cURL

curl -X DELETE 'https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891' \
  -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/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891', 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 632c34b4c9b7da3358ac9891",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "DELETE",
    "url": "https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891",
    "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:

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

Request Parameters

Name	Location	Type	Required	Description
schemaKey	Path	string	✅	The key of the Custom Object / Standard Object Schema. For custom objects, the key must include t...
id	Path	string	✅	id of the record to be updated. Available on the Record details page under the 3 dots or in the u...

Response Codes

Code	Description	Schema
200	Successful response	- id (string) (e.g. 661c06b4ffde146bdb469442): id of the deleted object - success (boolean) (e.g. True): boolean that defines if th...
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.

---

GET /objects/{schemaKey}/records/{id}

Summary: Get Record By Id

Allows you to get a Standard Object like business and custom object record by Id

Version Header: 2021-07-28

Operation ID: get-record-by-id

Tags: Records

cURL

curl -X GET 'https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891' \
  -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/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891', 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 632c34b4c9b7da3358ac9891",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "GET",
    "url": "https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891",
    "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:

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

Request Parameters

Name	Location	Type	Required	Description
schemaKey	Path	string	✅	The key of the Custom Object / Standard Object Schema. For custom objects, the key must include t...
id	Path	string	✅	id of the record to be updated. Available on the Record details page under the 3 dots or in the u...

Response Codes

Code	Description	Schema
200	Successful response	- record (IRecordSchema)
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.

---

PUT /objects/{schemaKey}/records/{id}

Summary: Update Record

Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

Version Header: 2021-07-28

📖 Official Documentation

Operation ID: update-object-record

Tags: Records

cURL

curl -X PUT 'https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891?locationId=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/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891?locationId=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 632c34b4c9b7da3358ac9891",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "PUT",
    "url": "https://rest.gohighlevel.com/v1/objects/custom_objects.pet or business.email (for company's email)/records/632c34b4c9b7da3358ac9891",
    "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": {},
    "sendQuery": true,
    "queryParameters": {
      "parameters": [
        {
          "name": "locationId",
          "value": "VALUE"
        }
      ]
    }
  }
}

To use in n8n:

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

Request Parameters

Name	Location	Type	Required	Description
schemaKey	Path	string	✅	The key of the Custom Object / Standard Object Schema. For custom objects, the key must include t...
id	Path	string	✅	id of the record to be updated. Available on the Record details page under the 3 dots or in the u...
locationId	Query	string	✅

Request Body Schema

object — no documented properties

Response Codes

Code	Description	Schema
200	Successful response	- record (IRecordSchema)
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.

---

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