HighLevel: List templates — proposals list Documents Contracts Templates

← Proposals operations · Get started

Operation gohighlevel.list_documents_contracts_templates

Provider route: GET /proposals/templates. 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["proposals"]["listDocumentsContractsTemplates"]>[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.proposals.listDocumentsContractsTemplates(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.proposals.list_documents_contracts_templates(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.dateFrom	string	Optional
query.dateTo	string	Optional
query.type	string	Optional
query.name	string	Optional
query.isPublicDocument	boolean	Optional
query.userId	string	Optional
query.limit	string	Optional
query.skip	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 templates — proposals list Documents Contracts Templates — response body

Referenced models: List templates — proposals list Documents Contracts Templates — response body

Schemas

List templates — proposals list Documents Contracts Templates — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	Array of templates
data[]	Model	Each item	Expand List templates — proposals list Documents Contracts Templates — response body — data item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of templates
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID for request tracking

Referenced models: List templates — proposals list Documents Contracts Templates — response body — data item

List templates — proposals list Documents Contracts Templates — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Template ID
createdAt	string	Required within parent	Template creation date
deleted	boolean	Required within parent	Whether the template is deleted
docFormUrl	string	Optional	Document form URL (only present when isPublicDocument is true)
documentCount	JSON	Optional
documentCount (anyOf 1)	number	Alternative	Document count (only present when isPublicDocument is true)
documentCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Template ID (alias for _id)
isPublicDocument	boolean	Required within parent	Whether the template is a public document
locationId	string	Required within parent	Location ID
name	string	Required within parent	Template name
type	string	Required within parent	Template type Known values: proposal, estimate, contentLibrary
updatedAt	string	Required within parent	Template last update date
updatedBy	string	Required within parent	User ID who last updated the template
version	JSON	Required within parent
version (anyOf 1)	number	Alternative	Template version
version (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.list_documents_contracts_templates. Catalog operation: list-documents-contracts-templates. 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: ["documents_contracts_template/list.readonly"]

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

Official provider source