HighLevel: List Agents — agent Studio get Agents

← Agent studio operations · Get started

Operation gohighlevel.getagents

Provider route: GET /agent-studio/agent. 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["agentStudio"]["getAgents"]>[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.agentStudio.getAgents(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.agent_studio.get_agents(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.isPublished	string	Optional
query.limit	string	Required within parent
query.offset	string	Required within parent
query.source	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 List Agents (Deprecated) — response body

Referenced models: List Agents (Deprecated) — response body

Schemas

List Agents (Deprecated) — response body

Field	Type	Presence	Description and constraints
$	object	Root
agents	array	Required within parent	List of agents with metadata
agents[]	object	Each item
agents[].agentId	string	Optional	Agent ID
agents[].createdAt	string	Optional	Creation timestamp
agents[].description	string	Optional	Agent description
agents[].locationId	string	Optional	Location ID
agents[].name	string	Optional	Agent name
agents[].status	string	Optional	Agent status (always "active")
agents[].updatedAt	string	Optional	Last update timestamp
message	string	Required within parent	Response message
pagination	object	Required within parent	Pagination metadata
pagination.hasMore	boolean	Optional	Whether more agents exist
pagination.limit	JSON	Optional
pagination.limit (anyOf 1)	number	Alternative	Number of agents per page
pagination.limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination.offset	JSON	Optional
pagination.offset (anyOf 1)	number	Alternative	Starting position
pagination.offset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination.total	JSON	Optional
pagination.total (anyOf 1)	number	Alternative	Total number of agents
pagination.total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success status

Policy, approvals and errors

SDK function policy ID: gohighlevel.getagents. Catalog operation: getAgents. 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: ["agent-studio.readonly"]

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

Official provider source