HighLevel: Get Object Schema by key id

← Objects operations · Get started

Operation gohighlevel.get_object_schema_by_key

Provider route: GET /objects/{key}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["objects"]["getObjectSchemaByKey"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.objects.getObjectSchemaByKey(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.objects.get_object_schema_by_key(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.key	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.fetchProperties	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Object Schema by key id — response body

Referenced models: Get Object Schema by key id — response body

Schemas

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

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

Update Custom Field By Id — response body — field

Field	Type	Presence	Description and constraints
$	object	Root
acceptedFormats	string	Optional	Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Known values: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
allowCustomOption	boolean	Optional	Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
dataType	string	Required within parent	Type of field that you are trying to create Known values: TEXT, LARGE_TEXT, NUMERICAL, PHONE, MONETORY, CHECKBOX, SINGLE_OPTIONS, MULTIPLE_OPTIONS, DATE, TEXTBOX_LIST, FILE_UPLOAD, RADIO
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	Description of the field
fieldKey	string	Required within parent	Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.
id	string	Required within parent	Unique identifier of the object
locationId	string	Required within parent	Location Id
maxFileLimit	JSON	Optional
maxFileLimit (anyOf 1)	number	Alternative	Maximum file limit for uploads
maxFileLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Optional	Field name
objectKey	string	Required within parent	The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
options	array	Optional	Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
options[]	Model	Each item	Expand Update Custom Field By Id — request body — body options item
parentId	string	Required within parent	ID of the parent folder
placeholder	string	Optional	Placeholder text for the field
showInForms	boolean	Required within parent	Whether the field should be shown in forms

Referenced models: Update Custom Field By Id — request body — body options item

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

Update Custom Field By Id — request body — body options item

Field	Type	Presence	Description and constraints
$	object	Root
key	string	Required within parent	Key of the option (Included in Create and Response, excluded in Update)
label	string	Required within parent	Value of the option
url	string	Optional	URL associated with the option (Optional, valid only for RADIO type)

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_object_schema_by_key. Catalog operation: get-object-schema-by-key. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["objects/schema.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source