> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Document Template List

> Gets an array of DocumentTemplate objects.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/GetDocumentTemplateList
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ListAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/List/GetDocumentTemplateList:
    post:
      tags:
        - List_Agent
      summary: Get Document Template List
      description: |-
        Gets an array of DocumentTemplate objects.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ListAgent_GetDocumentTemplateList
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                format: int32
                type: integer
          text/json:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/xml:
            schema:
              type: array
              items:
                format: int32
                type: integer
          text/xml:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/x-www-form-urlencoded:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/json-patch+json:
            schema:
              type: array
              items:
                format: int32
                type: integer
          application/merge-patch+json:
            schema:
              type: array
              items:
                format: int32
                type: integer
        description: The identifiers of the DocumentTemplate object
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.DocumentTemplate
            text/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.DocumentTemplate
            application/xml:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.DocumentTemplate
            text/xml:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.DocumentTemplate
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.DocumentTemplate
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.DocumentTemplate
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.DocumentTemplate:
      description: "The template a document is based on is stored in the SO_arc\\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on.\r\n<para />\r\nCarrier object for DocumentTemplate.\r\nServices for the DocumentTemplate Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        DocumentTemplateId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: The list item
          type: string
        Tooltip:
          description: Tooltip or other description
          type: string
        SaveInDb:
          format: int32
          description: 1 = save document records in DB; otherwise not.
          type: integer
        Filename:
          description: Relative to TemplatePath
          type: string
        DefaultOref:
          description: Processed via tag substitution to give document reference
          type: string
        RecordType:
          description: >-
            1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see
            EAppntRecordTypes
          enum:
            - Unknown
            - Appointment
            - Document
            - Email
            - Fax
            - Phone
            - Todo
            - MergeDraft
            - MergeFinal
            - SavedReport
          type: string
        Deleted:
          format: int32
          description: >-
            0 -> record is active 1 -> record is 'deleted' and should not be
            shown in lists
          type: integer
        Direction:
          description: 1 = incoming, 2 = outgoing, see EAppntDirection
          enum:
            - Unknown
            - Incoming
            - Outgoing
            - SaintAll
          type: string
        AutoeventId:
          format: int32
          description: >-
            Which document plugin is responsible for the documents generated
            from this template
          type: integer
        QuoteDocType:
          description: What type of quote document is this.
          enum:
            - None
            - MailBody
            - MainDocument
            - QuoteLines
            - ConfirmationMailBody
            - ConfirmationLines
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Document templates](/en/automation/crmscript/howto/document/templates.md)
- [Get Document Template](/en/api/reference/restful/agent/list_agent/get-document-template.md)
- [Get Document Templates](/en/api/reference/restful/agent/list_agent/get-document-templates.md)
- [Get Document Template Entity](/en/api/reference/restful/rest/list_documenttemplate/get-document-template-entity.md)
- [Get Document Template Task](/en/api/reference/restful/agent/list_agent/get-document-template-task.md)
- [Get Document Template Properties](/en/api/reference/restful/rest/list_documenttemplate/get-document-template-properties.md)
