Skip to main content
GHL MCP Guide
OBS

Object Schema CRUD

Custom Objects & Schema · Advanced · Updated March 2026

Define and manage custom object schemas with field types, validation rules, and display settings to extend the CRM data model beyond contacts.

Object Schema CRUD lets you define entirely new data structures in GHL. Beyond contacts, opportunities, and the built-in objects, custom objects let you model any business data: properties, vehicles, projects, equipment, policies — whatever the client’s business needs to track.

What This MCP Tool Does

This tool handles creation, retrieval, and update of custom object schemas. A schema defines what a custom object looks like: its fields, their types, validation rules, and display settings. Once a schema exists, you can create records within it through Object Records.

Endpoint Reference

Create a schema: POST /objects Define a new custom object type with field definitions.

Get a schema by ID: GET /objects/{objectId} Retrieve the full schema definition including all fields.

Update a schema: PUT /objects/{objectId} Modify field definitions, validation rules, or display settings.

List all schemas: GET /objects Retrieve all custom object schemas in the sub-account.

Authentication

Requires a Private Integration Token (PIT) with the custom-objects or equivalent scope enabled.

Key Parameters

When defining a schema:

  • name — the object type name (e.g., “Properties”, “Vehicles”, “Projects”)
  • key — unique identifier key for the object type
  • fields — array of field definitions with types, labels, and validation
  • Field types include: text, number, date, dropdown, multi-select, boolean, and more
  • Display settings for how the object appears in the GHL UI

Important Notes

Custom objects are an advanced feature that fundamentally extends GHL’s data model. Plan your schema carefully before creating it. Changing field types or removing fields after records exist can cause data issues.

Think of schemas like database table definitions. The schema says “a Property has an address, a price, a status, and an agent.” The records (managed through Object Records) are the actual properties that follow that structure.

Schemas can be associated with built-in objects (contacts, opportunities) through the Associations tool. This is how you link custom data to existing CRM records — for example, linking a “Property” object to the contact who owns it.

For agencies building industry-specific solutions, custom objects are the differentiator. A real estate CRM with proper property objects is fundamentally more useful than one trying to jam property data into contact custom fields.

Common Questions

When should I use custom objects versus custom fields on contacts? Use custom fields when the data belongs to the contact (their birthday, their service preference). Use custom objects when the data is its own entity that relates to contacts (a property they own, a vehicle they service, a project they hired you for). If multiple contacts can relate to the same thing, it should be a custom object.

Can I create relationships between custom objects? Yes. Use Associations to define relationships between custom objects and built-in objects, and Relations to create specific links between records.

Is there a limit on the number of custom objects? Check the GHL platform documentation for current limits on custom object types and records per location.

Can custom objects trigger workflows? Check the workflow trigger documentation for custom object event support. If available, record creation and updates on custom objects can fire workflow automations.

Back to GHL MCP Guide