HighLevel: Search Object Records

← Objects operations · Get started

Operation gohighlevel.search_object_records

Provider route: POST /objects/{schemaKey}/records/search. 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"]["searchObjectRecords"]>[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.searchObjectRecords(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.search_object_records(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.schemaKey	string	Required within parent
body	Model	Required within parent	Expand Search Object Records — request body — body

Referenced models: Search Object Records — request body — body

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 Search Object Records — response body

Referenced models: Search Object Records — response body

Schemas

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 — 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 — 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

Policy, approvals and errors

SDK function policy ID: gohighlevel.search_object_records. Catalog operation: search-object-records. 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/record.readonly"]

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

Official provider source