Skip to main content
GET
/
api
/
crm
/
documenttemplates
Search DocumentTemplates
curl --request GET \
  --url https://spaces.nexudus.com/api/crm/documenttemplates \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A DocumentTemplate defines a reusable template for generating documents such as contracts, proposals, or invoices. Templates support HTML, Word, and binary output formats and can include dynamic merge fields populated from customer and business data.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the DocumentTemplate-List role.

​
Enums

ValueName
1Html
2Word
3Binary

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 0 for ascending, 1 for descending.

​
Filters

​
DocumentTemplate_Business
integer
Filter by iD of the business linked to this record.
​
DocumentTemplate_Business_Name
string
Filter by display name of the linked business (read-only).
​
DocumentTemplate_Name
string
Filter by the name value for this document template.
​
DocumentTemplate_Document
string
Filter by the document value for this document template.
​
DocumentTemplate_BinaryDocumentFileName
string
Filter by current file name of the binary document (read-only; upload via the corresponding URL field).
​
DocumentTemplate_NewBinaryDocumentUrl
string
Filter by uRL of a new file to upload as the binary document.
​
DocumentTemplate_ClearBinaryDocument
boolean
Filter by set to true to remove the current binary document file.
​
DocumentTemplate_TemplateOutputFormat
integer
Filter by the template output format value for this document template.

​
Range Filters

​
from_DocumentTemplate_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_DocumentTemplate_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_DocumentTemplate_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_DocumentTemplate_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/crm/documenttemplates?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/crm/documenttemplates?DocumentTemplate_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/crm/documenttemplates?from_DocumentTemplate_UpdatedOn=2025-01-01T00:00&to_DocumentTemplate_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
DocumentTemplate[]
The list of DocumentTemplate records matching the query. See the Get one DocumentTemplate endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each DocumentTemplate. The following fields are not populated in the Records[] response: Document, TemplateOutputFormat.To get all fields, fetch the full record using the Get one DocumentTemplate endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (0 = ascending, 1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "BinaryDocumentFileName": null,
      "NewBinaryDocumentUrl": null,
      "ClearBinaryDocumentFile": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "DocumentTemplate Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}