Describe what createDocument can fill in a template
Returns a published company template's addressable text blocks (those with a block link id), its API-enabled pricing tables (or the first table when none is API-enabled) with their visible columns, the company's document data items and how many primary recipients the template needs. Block text is plain text trimmed to about 2000 characters. An older version is answered from the template's latest published version. Unpublished, trashed, other companies' templates and templates the user's teams can't use are 404.
Permission
An OAuth access token with this scope. How to get a token
templates:readParameters
Not sure what to enter? Here’s where to find IDs.
idpath · stringrequiredclient_idquery · stringrequiredResponses
200Template structure.
idstringrequirednamestringrequiredprimaryRecipientCountintegerrequiredblocksarray of objectrequiredblockValues can replace.Item fields
blockLinkIdstringrequiredlabelstringrequiredtextstringrequiredpricingTablesarray of objectrequiredItem fields
apiLinkIdstring or nullrequiredapiLinkId createDocument's pricing rows name.namestringrequiredcolumnsarray of objectrequiredItem fields
idstringrequiredlabelstringrequiredtypestringrequireddataItemsarray of objectrequireddataItems.Item fields
idstringrequiredlabelstringrequiredtypestringrequiredvaluesarray of string401Missing or invalid bearer token or client ID.
errorstringrequirederror_descriptionstring403Insufficient scope, missing add-on, usage limit, or permission denial.
Exactly one of these:
OAuthError
errorstringrequirederror_descriptionstringApiErrorEnvelope
dataobjectrequiredFields
statusstringrequirederror. messagestringrequiredcodestringdocumentRefstringassetGenerationIdstringerrorsarray of objectItem fields
fieldstringrequiredmessagestringrequired404Requested resource was not found in the token's company.
dataobjectrequiredFields
statusstringrequirederror. messagestringrequiredcodestringdocumentRefstringassetGenerationIdstringerrorsarray of objectItem fields
fieldstringrequiredmessagestringrequired429Shared company API request quota exceeded. Wait before retrying.
Retry-Afterheader · integerdataobjectrequiredFields
statusstringrequirederror. messagestringrequiredretryAfterSecondsintegerrequired502The template's stored content could not be read.
dataobjectrequiredFields
statusstringrequirederror. messagestringrequiredcodestringdocumentRefstringassetGenerationIdstringerrorsarray of objectItem fields
fieldstringrequiredmessagestringrequiredRate limit
120 requests a minute per company, shared across REST, Zapier and MCP. On a 429, wait for Retry-After.