HighLevel: Objects schemas

← Objects operations · All schemas

Create Custom Object — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	Pet Object`s description
key	string	Required within parent	key that would be used to refer the Custom Object internally (lowercase + underscore_separated). 'custom_objects.' would be added as prefix by default
labels	JSON	Required within parent	This is what your custom object will be called. These labels will be used to display your custom object on the UI
labels (allOf 1)	Model	All variants apply	Expand Create Custom Object — request body — body labels plural, singular
locationId	string	Required within parent	Location Id
primaryDisplayPropertyDetails	JSON	Required within parent	Primary property which will be displayed on the record page
primaryDisplayPropertyDetails (allOf 1)	Model	All variants apply	Expand Create Custom Object — request body — body primary Display Property Details data Type, key, name

Referenced models: Create Custom Object — request body — body primary Display Property Details data Type, key, name, Create Custom Object — request body — body labels plural, singular

Create Custom Object — request body — body labels plural, singular

Field	Type	Presence	Description and constraints
$	object	Root
plural	string	Required within parent	Plural name of the custom object
singular	string	Required within parent	Singular name of the custom object

Create Custom Object — request body — body primary Display Property Details data Type, key, name

Field	Type	Presence	Description and constraints
$	object	Root
dataType	string	Required within parent	Primary property data Type (it can either be TEXT or NUMERICAL type)
key	string	Required within parent	key that would be used to refer the custom field internally (lowercase + underscore_separated). 'custom_objects.{{objectKey}}' would be added as prefix by default is not passed
name	string	Required within parent	Name of the Primary property name which will be displayed on the record page

Create Custom Object — response body

Field	Type	Presence	Description and constraints
$	object	Root
object	Model	Optional	Expand Create Custom Object — response body — object

Referenced models: Create Custom Object — response body — object

Create Custom Object — response body — object

Field	Type	Presence	Description and constraints
$	object	Root
dateAdded	string	Required within parent	Date and time when the object was added Format: date-time
dateUpdated	string	Required within parent	Date and time when the object was last updated Format: date-time
description	string	Optional	Custom / Standard Object Descriptions for example , Pet Object`s description
id	string	Required within parent	id of the custom / standard object schema
key	string	Required within parent	key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default
labels	JSON	Required within parent	This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
labels (allOf 1)	Model	All variants apply	Expand Create Custom Object — request body — body labels plural, singular
locationId	string	Required within parent	location's id
primaryDisplayProperty	string	Required within parent	Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects
standard	boolean	Required within parent	false in case of custom objects and true in case of standard objects like contacts and opportunities
type	object	Optional	Object`s Type

Referenced models: Create Custom Object — request body — body labels plural, singular

Create Record — response body

Field	Type	Presence	Description and constraints
$	object	Root
record	Model	Optional	Expand Create Record — response body — record

Referenced models: Create Record — response body — record

Create Record — response body — record

Field	Type	Presence	Description and constraints
$	object	Root
dateAdded	string	Required within parent	Date and time when the object was added Format: date-time
dateUpdated	string	Required within parent	Date and time when the object was last updated Format: date-time
followers	array	Required within parent	Follower (User's ids). Limited to 10 for now
followers[]	string	Each item
id	string	Required within parent	id of the record
owner	array	Required within parent	Owner (User's id). Limited to 1 for now. Only Supported with custom objects
owner[]	string	Each item
properties	string	Required within parent	Properties of the record

Delete Record — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	id of the deleted object
success	boolean	Optional	boolean that defines if the operation was a success or not

Get Object Schema by key id — response body

Field	Type	Presence	Description and constraints
$	object	Root
cache	boolean	Required within parent	Is the response served from cache
fields	array	Optional
fields[]	Model	Each item	Expand Update Custom Field By Id — response body — field
object	Model	Optional	Expand Create Custom Object — response body — object

Referenced models: Create Custom Object — response body — object, Update Custom Field By Id — response body — field

Get all objects for a location — response body

Field	Type	Presence	Description and constraints
$	object	Root
objects	array	Optional
objects[]	Model	Each item	Expand Create Custom Object — response body — object

Referenced models: Create Custom Object — response body — object

Search Object Records — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location Id
page	number	Required within parent	Page
pageLimit	number	Required within parent	Page Limit
query	string	Required within parent	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 within parent
searchAfter[]	string	Each item

Search Object Records — response body

Field	Type	Presence	Description and constraints
$	object	Root
records	array	Optional	Records
records[]	Model	Each item	Expand Search Object Records — response body — records item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total Number of records
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search Object Records — response body — records item

Search Object Records — response body — records item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	Date and time when the object was added Format: date-time
createdBy	JSON	Required within parent	Created By Meta
createdBy (allOf 1)	Model	All variants apply	Expand Search Object Records — response body — records item created By channel, created At, source, source Id
followers	array	Required within parent	Follower (User's ids). Limited to 10 and supported for custom objects for now
followers[]	string	Each item
id	string	Required within parent	id of the record
lastUpdatedBy	JSON	Required within parent	Last Updated By Meta
lastUpdatedBy (allOf 1)	Model	All variants apply	Expand Search Object Records — response body — records item created By channel, created At, source, source Id
locationId	string	Required within parent	Location Id
objectId	string	Required within parent	ObjectId Id
objectKey	string	Required within parent	ObjectId key
owner	array	Required within parent	Owner (User's id). Limited to 1 for now . Only supported for custom objects for now
owner[]	string	Each item
properties	string	Required within parent	Properties of the record
searchAfter	array	Required within parent
searchAfter[]	JSON	Each item
searchAfter[] (anyOf 1)	number	Alternative
searchAfter[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	Date and time when the object was last updated Format: date-time

Referenced models: Search Object Records — response body — records item created By channel, created At, source, source Id

Search Object Records — response body — records item created By channel, created At, source, source Id

Field	Type	Presence	Description and constraints
$	object	Root
channel	string	Required within parent	Creation Channel
createdAt	string	Required within parent	Created At
source	string	Required within parent	From where the record was created
sourceId	string	Required within parent	User/Resource Id

Update Object Schema By Key Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional
description (anyOf 1)	string	Alternative	Pet Object`s description
description (anyOf 2)	null	Alternative
labels	JSON	Optional	This is how your custom object will be displayed
labels (allOf 1)	Model	All variants apply	Expand Update Object Schema By Key Id — request body — body labels plural, singular
locationId	string	Required within parent	location id
searchableProperties	array	Required within parent	Searchable Fields: Provide the field key of your object that you want to search on, using the format (custom_object.<object_name>.<field_key>).
searchableProperties[]	string	Each item

Referenced models: Update Object Schema By Key Id — request body — body labels plural, singular

Update Object Schema By Key Id — request body — body labels plural, singular

Field	Type	Presence	Description and constraints
$	object	Root
plural	string	Optional	Plural name of the custom object
singular	string	Optional	Singular name of the custom object