Skip to content

Content Template Catalogs

All six operations use POST /public-api/publicapi.v1.ContentTemplate/. They require the creator’s settings read access and exact API scopes. Operational content-template access alone is insufficient; these are not the problem or work-order template discovery contracts.

Email list/get require email_template:read, document list/get document_template:read, and advanced-task definition list/get advanced_task_definition:read. The last is distinct from advanced_task:read for external task instances.

List methodDetail methodKind
ListEmailTemplatesGetEmailTemplateVersioned email templates
ListDocumentTemplatesGetDocumentTemplateVersioned document templates
ListAdvancedTaskDefinitionsGetAdvancedTaskDefinitionLive, unversioned advanced-task definitions

Lists accept:

{ "query": "Inspection", "pageSize": 25 }

query is an optional trimmed, literal case-insensitive name substring, maximum 200 characters. There is no regex syntax. Page size defaults to 25, maximum 100. Results are ordered by stable ID. Continue with nextAfterId as afterId, keeping the query unchanged; omit optional afterId rather than sending an empty UUID. Detail takes {"id":"<template-or-definition-id>"}.

Lists return templates; detail returns template. Name is capped at 200 characters; description at 200 in lists and 2,000 in detail. Check metadataTruncated. No email source, document layout/configuration, selectors, filters, checklist bodies, or execution configuration is returned.

Email/document metadata includes versioned, hasDraft, optional currentPublication, and hasUnpublishedChanges. The latter compares draft source/configuration with the publication, not names/descriptions. Document templates additionally have numbered draft revision metadata. No publication means an unpublished draft, not a ready-to-send or ready-to-generate template.

Advanced-task definitions instead expose taskType and checklistItemCount; they are not drafts and have no publication lifecycle. These endpoints do not create definitions or execute tasks. Use the separate external task-instance API for supported instance completion work.

Contract

Generated Reference
POST /public-api/publicapi.v1.ContentTemplate/ListEmailTemplates
Request ContentTemplateListRequest
Response ContentTemplateListResponse

ContentTemplateListRequest

Field Type Description
page_size int32 Defaults to 25; at most 100. Results are ordered by stable ID.
after_id optional string
query string Literal, case-insensitive name substring. Keep unchanged when paging.

ContentTemplateListResponse

Field Type
templates repeated ContentTemplate
next_after_id optional string

Contract

Generated Reference
POST /public-api/publicapi.v1.ContentTemplate/GetEmailTemplate
Request ContentTemplateGetRequest
Response ContentTemplateGetResponse

ContentTemplateGetRequest

Field Type
id string

ContentTemplateGetResponse

Field Type
template ContentTemplate

Contract

Generated Reference
POST /public-api/publicapi.v1.ContentTemplate/ListDocumentTemplates
Request ContentTemplateListRequest
Response ContentTemplateListResponse

ContentTemplateListRequest

Field Type Description
page_size int32 Defaults to 25; at most 100. Results are ordered by stable ID.
after_id optional string
query string Literal, case-insensitive name substring. Keep unchanged when paging.

ContentTemplateListResponse

Field Type
templates repeated ContentTemplate
next_after_id optional string

Contract

Generated Reference
POST /public-api/publicapi.v1.ContentTemplate/GetDocumentTemplate
Request ContentTemplateGetRequest
Response ContentTemplateGetResponse

ContentTemplateGetRequest

Field Type
id string

ContentTemplateGetResponse

Field Type
template ContentTemplate

Contract

Generated Reference
POST /public-api/publicapi.v1.ContentTemplate/ListAdvancedTaskDefinitions
Request ContentTemplateListRequest
Response ContentTemplateListResponse

ContentTemplateListRequest

Field Type Description
page_size int32 Defaults to 25; at most 100. Results are ordered by stable ID.
after_id optional string
query string Literal, case-insensitive name substring. Keep unchanged when paging.

ContentTemplateListResponse

Field Type
templates repeated ContentTemplate
next_after_id optional string

Contract

Generated Reference
POST /public-api/publicapi.v1.ContentTemplate/GetAdvancedTaskDefinition
Request ContentTemplateGetRequest
Response ContentTemplateGetResponse

ContentTemplateGetRequest

Field Type
id string

ContentTemplateGetResponse

Field Type
template ContentTemplate