Get Template By Template ID API

8min

Introduction
Unlock instant access to template specifics with our Get Template by Template ID API. Retrieve in-depth template details effortlessly by providing the unique template ID. Whether it's template names, files, or any other crucial information you seek, our API delivers precisely what you need. Say goodbye to guesswork and hello to pinpoint template retrieval. Simplify your workflow with the Get Template by Template ID API – your gateway to seamless template management. Start optimizing your template retrieval process today!
Authentication
API authentication is a crucial security process that ensures authorized access to an application programming interface (API). It involves validating the identity of users or systems seeking to interact with the API. Please use the access token shared with you by your assigned Signzy's CSM. Please set the value of the key Authorization in the headers to the access token, while making an API call. In this way, Signzy's system will be able to authenticate you and you will be able to make a successful API call. 
API Details
The details of the API can be found here.
Sample cURL
Pre Production
Production
curl --location --request GET 'https://api.signzy.app/api/v3/template/get/:templateId' \
--header 'Authorization: *****************************' \
--header 'Content-Type: application/json' \
--data '{
}'
curl --location --request GET 'https://api.signzy.app/api/v3/template/get/:templateId' \
--header 'Authorization: *****************************' \
--header 'Content-Type: application/json' \
--data '{
}'
﻿
Sample Response
200
{
"status": "success",
"statusDesp": "Search Successfully",
"templateDetails": 
[{
    "templateName" : "name of template",
    "templateType" : "docx, html, editablePdf",
	"templateData" : "url or base64",
    "templateRequiredVariables" : "json data keys to be filled in  template in desired format",
    "templateId": ""
}]
}
{
"status": "success",
"statusDesp": "Search Successfully",
"templateDetails": 
[{
    "templateName" : "name of template",
    "templateType" : "docx, html, editablePdf",
	"templateData" : "url or base64",
    "templateRequiredVariables" : "json data keys to be filled in  template in desired format",
    "templateId": ""
}]
}
﻿
Output Parameters
Key
Description
Type
status
Status
String
statusDesp 
Description of the status
String
templateDetails
Details of all the templates
Array Of Objects
templateName
Name of the template
String
templateType
Type of the template (docx, html, editablePdf)
String
templateData
URL or base64 data of the template
String
templateRequiredVariables
JSON data keys to be filled in the template in desired format
String
templateId
Template ID
String
Sample Errors
400
401
500
{
    "name": "error",
    "message": "Invalid URL extension",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
{
    "name": "error",
    "message": "Invalid URL extension",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
﻿
Error Parameters
Parameter
Type
Description
name
String
In case of errors, it will have the value "error". It represents an error.
message
String
Message for the error
reason
String
Reasons for the error
type
String
Type of error
statusCode
String
Status code of the error
Error Codes
Error Code
Error Message
Explanation
400
Bad Request
Input parameter has a missing required parameter or invalid inputs
401
Authorization Failed
Authorization token is invalid
500
Internal Server Error
Internal error at Signzy, Please write to us at [email protected]
﻿

Key	Description	Type
status	Status	String
statusDesp	Description of the status	String
templateDetails	Details of all the templates	Array Of Objects
templateName	Name of the template	String
templateType	Type of the template (docx, html, editablePdf)	String
templateData	URL or base64 data of the template	String
templateRequiredVariables	JSON data keys to be filled in the template in desired format	String
templateId	Template ID	String

Parameter	Type	Description
name	String	In case of errors, it will have the value "error". It represents an error.
message	String	Message for the error
reason	String	Reasons for the error
type	String	Type of error
statusCode	String	Status code of the error

Error Code	Error Message	Explanation
400	Bad Request	Input parameter has a missing required parameter or invalid inputs
401	Authorization Failed	Authorization token is invalid
500	Internal Server Error	Internal error at Signzy, Please write to us at [email protected]

Updated 27 Feb 2024

Did this page help you?

Get All Templates API

Delete Template API