Template Detail

Test API endpoints in real-time

Request

Query Parameters

Response

Click Send to get a response

1. Endpoint Details

Endpoint Details

HTTP Method

GET

Endpoint URL

/api/v1/apiwarehouse/template_detail/{template_id}

2. Query Parameters

Query Parameters

template_idstring (required)

The unique identifier of the template to retrieve details for

3. Required Headers

Required Headers

acceptapplication/json

x-api-keyYour API authentication key

4. Example Request

Bash

curl --location --request GET 'https://api.swellsign.com/api/v1/apiwarehouse/template_detail/68c15da5c28a11f967e6b46b'
--header 'accept: application/json'
--header 'x-api-key: xWuCfym7ad5f674t3ry7aDpZ3gDJwtE34Ib9raiPEM5xk6IMLBz6gA'

5. Example Response

Json

{
"success": true,
"data": {
  "template": {
    "_id": "68c15da5c28a11f967e6b46b",
    "name": "DOH 4359 Template  - Clark Salesforce (1)_1.pdf",
    "created_by": "Riya Maheshwari",
    "created_at": "2025-09-10T11:14:49.434Z",
    "organization_name": "Joyfull"
  },
  "fields": [
    {
      "field_name": "SIgnature",
      "type": "signature",
      "role": "qa"
    },
    {
      "field_name": "Signature 1",
      "type": "signature",
      "role": "provider"
    },
    {
      "field_name": "Signature 3",
      "type": "signature",
      "role": null
    }
  ],
  "roles": [
    {
      "role": "provider",
      "color": "#000000"
    },
    {
      "role": "qa",
      "color": "#2caa6f"
    }
  ]
}
}

6. Response Fields

successboolean

Indicates if the request was successful

dataobject

Container object with template details, fields, and roles

data.templateobject

Template metadata including ID, name, creator, and organization

data.fieldsarray

Array of field objects defined in the template

data.rolesarray

Array of role objects with associated colors

Template Object Fields

_idstring

Unique template identifier

namestring

Template name/title

created_bystring

Name of the user who created the template

created_atstring (ISO date)

Timestamp when the template was created

organization_namestring

Name of the organization that owns the template

Field Object Structure

field_namestring

Name/label of the field as defined in the template

typestring

Field type (e.g., "signature", "text", "date", "checkbox", etc.)

rolestring/null

Role assigned to this field (e.g., "provider", "qa") or null if no role assigned

Role Object Structure

rolestring

Role name used in template field assignments

colorstring

Hex color code associated with the role for visual identification