HighLevel: List Call Logs

← Voice AI operations · Get started

Operation gohighlevel.get_call_logs

Provider route: GET /voice-ai/dashboard/call-logs. 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["voiceAi"]["getCallLogs"]>[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.voiceAi.getCallLogs(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.voice_ai.get_call_logs(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.agentId	string	Optional
query.contactId	string	Optional
query.callType	string	Optional	One of: LIVE, TRIAL
query.startDate	number	Optional
query.endDate	number	Optional
query.actionType	string	Optional	One of: CALL_TRANSFER, DATA_EXTRACTION, IN_CALL_DATA_EXTRACTION, WORKFLOW_TRIGGER, SMS, APPOINTMENT_BOOKING, CUSTOM_ACTION, KNOWLEDGE_BASE
query.sortBy	string	Optional	One of: duration, createdAt
query.sort	string	Optional	One of: ascend, descend
query.page	number	Optional	Default: 1
query.pageSize	number	Optional	Default: 10

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 Call Logs — response body

Referenced models: List Call Logs — response body

Schemas

7 more schemas are linked from the tables above, on the schema pages.

List Call Logs — response body

Field	Type	Presence	Description and constraints
$	object	Root
callLogs	array	Required within parent	Array of call logs
callLogs[]	Model	Each item	Expand List Call Logs — response body — call Logs item
page	JSON	Required within parent
page (anyOf 1)	number	Alternative	Page number starting from 1
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Required within parent
pageSize (anyOf 1)	number	Alternative	Number of items per page
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of items
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Call Logs — response body — call Logs item

List Call Logs — response body — call Logs item

Field	Type	Presence	Description and constraints
$	object	Root
agentId	string	Required within parent	Agent ID associated with the call
contactId	string	Optional	Associated contact ID
createdAt	string	Required within parent	Timestamp when the call was created Format: date-time
duration	JSON	Required within parent
duration (anyOf 1)	number	Alternative	Call duration in seconds
duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
executedCallActions	array	Required within parent	Actions performed during the call. Note: The APPOINTMENT_BOOKING action will only be visible in executedCallActions from Sep 9th 2025.
executedCallActions[]	Model	Each item	Expand List Call Logs — response body — call Logs item executed Call Actions item
extractedData	JSON	Optional	Dynamic data extracted from the call based on agent configuration Additional keys: allowed
extractedData (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
fromNumber	string	Optional	Caller phone number
id	string	Required within parent	Unique identifier for the call
isAgentDeleted	boolean	Required within parent	Whether the agent is deleted
messageId	string	Optional	Message identifier associated with the call
summary	string	Required within parent	Call summary
transcript	string	Required within parent	Call transcript
translation	JSON	Optional	Transcript translation details
translation (allOf 1)	Model	All variants apply	Expand Patch Agent — response body — translation enabled, language
trialCall	boolean	Required within parent	Whether this call was a trial call

Referenced models: Delete Event — request body — body, List Call Logs — response body — call Logs item executed Call Actions item, Patch Agent — response body — translation enabled, language

Delete Event — request body — body

Field	Type	Presence	Description and constraints
$	object	Root

List Call Logs — response body — call Logs item executed Call Actions item

Field	Type	Presence	Description and constraints
$	object	Root
actionId	string	Optional	Action ID reference
actionName	string	Required within parent	Action name
actionParameters	JSON	Optional	Action parameters - structure varies by actionType
actionParameters (anyOf 1)	Model	Alternative	Expand List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / transferToType: number
actionParameters (anyOf 2)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value
actionParameters (anyOf 3)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value
actionParameters (anyOf 4)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters trigger Message, trigger Prompt, workflow Id
actionParameters (anyOf 5)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt
actionParameters (anyOf 6)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters calendar Id, days Of Offering Dates, hours Between Slots, slots Per Day
actionParameters (anyOf 7)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters api Details, selected Paths, trigger Message, trigger Prompt
actionParameters (anyOf 8)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt
actionType	string	Required within parent	Action type Known values: CALL_TRANSFER, DATA_EXTRACTION, IN_CALL_DATA_EXTRACTION, WORKFLOW_TRIGGER, SMS, APPOINTMENT_BOOKING, CUSTOM_ACTION, KNOWLEDGE_BASE
executedAt	string	Optional	When the action was executed Format: date-time
triggerReceivedAt	string	Optional	When the trigger was received Format: date-time

Referenced models: List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters calendar Id, days Of Offering Dates, hours Between Slots, slots Per Day, List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / transferToType: number, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters api Details, selected Paths, trigger Message, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters trigger Message, trigger Prompt, workflow Id

Patch Agent — response body — translation enabled, language

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Optional	Whether translation is enabled
language	string	Optional	Translation language code

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value

Field	Type	Presence	Description and constraints
$	object	Root
contactFieldId	string	Required within parent	ID of the contact field to be updated with the extracted data
description	string	Required within parent	Description of what data to extract
examples	array	Required within parent	Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.
examples[]	string	Each item
overwriteExistingValue	boolean	Optional	Whether to overwrite existing field value if already set, default is false Default: false

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt

Field	Type	Presence	Description and constraints
$	object	Root
knowledgeBaseId	string	Required within parent	Knowledge base ID to query
triggerPrompt	string	Required within parent	When to query the knowledge base

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt

Field	Type	Presence	Description and constraints
$	object	Root
messageBody	string	Required within parent	SMS message content to send
triggerMessage	string	Required within parent	Message to tell the caller
triggerPrompt	string	Required within parent	When to send the SMS

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_call_logs. Catalog operation: get-call-logs. 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: ["voice-ai-dashboard.readonly"]

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

Official provider source