Get one DocumentTemplate

GET

api

crm

documenttemplates

{id}

Get one DocumentTemplate

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/documenttemplates/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/crm/documenttemplates/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/documenttemplates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "Document": "<string>",
  "BinaryDocumentFileName": "<string>",
  "NewBinaryDocumentUrl": "<string>",
  "ClearBinaryDocumentFile": true,
  "TemplateOutputFormat": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the DocumentTemplate record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/crm/documenttemplates/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/documenttemplates/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/documenttemplates/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Display name of the linked business (read-only).

string

The name value for this document template.

string

The document value for this document template.

string

Current file name of the binary document (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the binary document.

boolean

Set to true to remove the current binary document file.

integer

The template output format value for this document template. See eDocumentTemplateFormat enum values: 1 = Html, 2 = Word, 3 = Binary.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "Document": null,
  "BinaryDocumentFileName": null,
  "NewBinaryDocumentUrl": null,
  "ClearBinaryDocumentFile": null,
  "TemplateOutputFormat": 0,
  "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
}

Get multiple DocumentTemplatesRetrieve multiple DocumentTemplate records by their Ids in a single request.

Get one DocumentTemplate

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/documenttemplates/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/crm/documenttemplates/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/documenttemplates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "Document": "<string>",
  "BinaryDocumentFileName": "<string>",
  "NewBinaryDocumentUrl": "<string>",
  "ClearBinaryDocumentFile": true,
  "TemplateOutputFormat": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200