Skip to main content
POST
/
templates
/
list
List
curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/templates/list \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "memberId": "<string>",
  "teamId": "<string>",
  "folderId": "<string>",
  "allMembers": true,
  "search": "<string>",
  "personal": true,
  "shared": true,
  "mostRecent": 123,
  "sortBy": "<string>",
  "collectionCode": "<string>",
  "packageTypes": [
    "<string>"
  ],
  "types": [
    "<string>"
  ],
  "take": 123,
  "skip": 123
}
'
{
  "items": [
    {
      "organizationId": "<string>",
      "templateId": "<string>",
      "templateCode": "<string>",
      "memberId": "<string>",
      "teamId": "<string>",
      "folderId": "<string>",
      "shared": true,
      "timeCreated": "<string>",
      "timeUpdated": "<string>",
      "timeLastUsed": "<string>",
      "name": "<string>",
      "description": "<string>",
      "packageType": "<string>",
      "type": "<string>",
      "state": "<string>",
      "documents": [
        {
          "documentId": "<string>",
          "documentCode": "<string>",
          "index": 123,
          "name": "<string>",
          "fileName": "<string>"
        }
      ],
      "signers": [
        {
          "signerId": "<string>",
          "index": 123,
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "role": "<string>",
          "templateRole": "<string>",
          "type": "<string>"
        }
      ],
      "recipients": [
        {
          "recipientId": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "templateRole": "<string>",
          "type": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "take": 123,
  "skip": 123
}
Users in iinked Sign can create re-usable Templates in the UI that can be used to generate new signing Packages for workflows that are used frequently. You can get a list of the templates and use a template in the creation of a package.

​
Request

You can retrieve a list of an organization’s member’s current templates by calling templates/list.
Request
POST /templates/list
{
    "memberId": "e4f0bce5-30fc-43c4-b9ee-364ff5b04dea",
    "search": null,
    "personal": true,
    "shared": null,
    "mostRecent": null,
    "sortBy": "last_used",
    "take": 100,
    "skip": 0
}

​
Body

Some filters are restricted based on the authentication method used or permissions of the organization member.To filter templates for other members, you must use one of the following authentication methods:
  • Organization API Key
  • User API Key with Sign Editor or Template Editor role enabled
  • Organization OAuth App
To filter templates for teams, the authenticated member must belong to the specified team.
​
memberId
string
The member ID to retrieve templates for.
​
teamId
string
The team ID to retrieve templates for.
​
folderId
string
Filter templates by folder ID.
​
allMembers
boolean
When true, retrieves templates for all members in the organization.
​
search
string
Filter templates by search terms.
This performs a full text search on template name, description, message, category, client number, matter number, as well as signer and recipient first name, last name, email, mobile number, and template role.You can use * as a wildcard character to perform suffix matching (e.g., Contract* matches any template whose name contains a word starting with “Contract”).
​
personal
boolean
When true, retrieves members personal templates only.
​
shared
boolean
When true, retrieves organization shared templates only.
​
mostRecent
number
Filter templates last used within the last X number of days.
​
sortBy
string
default:"created"
Sort results by by one of the following:
​
collectionCode
string
Filter templates by collection code.
​
packageTypes
string[]
Filter templates by package type.
​
types
string[]
Filter templates by template type.
​
take
number
default:50
Number of templates to return.
​
skip
number
Number of templates to skip.

​
Response

The response will contain a list of templates that match the provided filter criteria.
​
items
object[]
Array of templates returned.
​
total
number
Total number of templates that match filter criteria.
​
take
number
Number of templates returned per request.
​
skip
number
Number of templates skipped.