Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Charthop template API

The template API from Charthop — 10 operation(s) for template.

Charthop template API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include template. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 10 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

15 operations 10 paths 13 schemas 2 DELETE4 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
Resource Areas
1

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 2 DELETE, 4 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

template 15
GET
/v1/org/{orgId}/template
Return all templates in the organization paginated
findTemplates 4 params → 200400401404
POST
/v1/org/{orgId}/template
Create a template
createTemplate 2 params → 201400401403404
POST
/v1/org/{orgId}/template/bulk/delete
Delete a set of templates
bulkDeleteTemplates 2 params → 200400401403404
POST
/v1/org/{orgId}/template/bulk/duplicate
Duplicate a set of templates
bulkDuplicateTemplates 2 params → 200400401403404
POST
/v1/org/{orgId}/template/email
Create a template
createEmailTemplate 1 param → 201400401403404
GET
/v1/org/{orgId}/template/email/{templateName}
Return a particular email template by name
getEmailTemplate 1 param → 200400404
DELETE
/v1/org/{orgId}/template/email/{templateName}
Delete a template
deleteEmailTemplate 1 param → 204400401403404
PATCH
/v1/org/{orgId}/template/email/{templateName}
Update an existing template
updateEmailTemplate 2 params → 204400401403404
GET
/v1/org/{orgId}/template/{templateId}
Return a particular template by id
getTemplate 2 params → 200400404
PATCH
/v1/org/{orgId}/template/{templateId}
Update an existing template
updateTemplate 3 params → 204400401403404
DELETE
/v1/org/{orgId}/template/{templateId}
Delete a template
deleteTemplate 2 params → 204400401403404
GET
/v1/org/{orgId}/template/{templateId}/download
If the template is a file template, download the file
downloadTemplate 2 params → 400401403404
POST
/v1/org/{orgId}/template/{templateId}/generate
Automatically generate PDFs of the templates, and distribute emails to managers and people to download
generateTemplates 3 params → 200400401403404
POST
/v1/org/{orgId}/template/{templateId}/preview
Preview template content without saving it
previewTemplate 9 params → 204400401403404
POST
/v1/org/{orgId}/template/{templateId}/render
Render a template by evaluating it against an existing job
renderTemplate 9 params → 201400401403404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Process (29 properties), Template (26 properties), GenerateTemplateRequest (14 properties), UpdateTemplate (12 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
LogData
object
4 properties 3 required
ResultsAccess
object
2 properties 1 required
Template
object
26 properties 5 required
TemplatePreviewRequest
object
2 properties 1 required
GenerateTemplateRequest
object
14 properties 5 required
ResultsTemplate
object
3 properties 1 required
SignaturePlacement
object
8 properties 4 required
Attribution
object
6 properties
TemplateRenderResponse
object
1 property 1 required
UpdateTemplate
object
12 properties
CreateTemplate
object
12 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-template-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API