Overview API Reference API Explorer Need help?

Get template

Retrieve the template in a workspace by ID.

A document template is a pre-designed document format with merge tags and properties that provides a consistent structure and layout for creating similar documents efficiently.

HTTP request

GET https://api.wordfields.com/v1.0/templates/{id}

Request headers

Name	Description
x-api-key	API key. Required. Learn more about authentication.

Response

If successful, this method returns a 200 OK response code and the template resource in the response body.

Example

The following example shows a request to retrieve a template resource based on the ID.

Request

GET https://api.wordfields.com/v1.0/templates/1499179389525622343

Response

Here is what the response to retrieve the template metadata will look like:

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8

{
  "id": "1499179389525622343",
  "name": "Non-disclosure agreement",
  "description": "A legally enforceable contract that establishes confidentiality between two parties."
  "createdDateTime": "2024-05-03T05:50:28Z",
  "files": [
    {
      "id": "849935992235229184",
      "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "filename": "Non-disclosure agreement.docx",
      "size": 20316,
      "createdDateTime": "2024-05-03T05:50:28Z",
      "lastModifiedDateTime": "2024-05-05T08:13:53Z",
      "usedProperties": [
        {
          "name": "Confidential Information",
          "required": true
       	},        
        {
          "name": "Disclosing Party Name",
          "required": true
        },
        {
          "name": "EffectiveDate",
          "required": true
        },
        {
          "name": "Location",
          "required": true
        }
      ]
    }
  ],
  "properties": [
    {
      "type": "text",
      "name": "Confidential Information",
      "label": "Confidential Information"
    },
    {
      "type": "text",
      "name": "Disclosing Party Name",
      "label": "Disclosing Party Name",
      "description": "Legal entity or individual who is providing confidential information to another party."
    },
    {
      "type": "date",
      "name": "EffectiveDate",
      "label": "Effective Date"
    },
    {
      "type": "select",
      "name": "Location",
      "allowedValues": [
        "London",
        "New York",
        "San Francisco"
      ],
      "defaultValue": "San Francisco"
    },
  ]
}