Luminance Document Templates API

openapi: 3.2.0
info:
  title: Luminance Document Templates API
  version: '1.5'
  description: 'Operations tagged Document Templates across 2 of this provider''s published API definitions: luminance-document-templates-api-openapi.yml, luminance-public-api-v2-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{moniker}.app.luminance.com
  description: Your Luminance instance
  variables:
    moniker:
      default: your-instance
      description: Instance moniker (e.g. acme)
security:
- bearerAuth: []
tags:
- name: Document Templates
paths:
  /api2/projects/{project_id}/document_templates:
    get:
      tags:
      - Document Templates
      summary: List document templates in project
      description: Contract/document templates for the project. Use GET .../document_templates/{id}/fields to get the schema required for contract creation.
      parameters:
      - $ref: '#/components/parameters/projectId'
      - in: query
        name: id
        schema:
          type: integer
        description: Filter by document template ID
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: default_folder_id
        schema:
          type: integer
        description: Folder ID where documents created from this template are saved
      - in: query
        name: state
        schema:
          type: string
        description: active or deleted
      - in: query
        name: media_type
        schema:
          type: string
        description: Media type (e.g. MS Word MIME type)
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
      - in: query
        name: offset
        schema:
          type: integer
          minimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentTemplate'
              example:
              - id: 1
                created_at: '2024-01-15T12:00:00.000Z'
                created_by: 1
                name: Joe Bloggs
                project_id: 1
                default_folder_id: 1
                media_type: application/pdf
                state: active
                options: {}
    servers:
    - url: https://{moniker}.app.luminance.com
      description: Your Luminance instance
      variables:
        moniker:
          default: your-instance
          description: Instance moniker (e.g. acme)
  /api2/projects/{project_id}/document_templates/{document_template_id}:
    get:
      tags:
      - Document Templates
      summary: Get document template by id
      parameters:
      - $ref: '#/components/parameters/projectId'
      - in: path
        name: document_template_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTemplate'
              example:
                id: 1
                created_at: '2024-01-15T12:00:00.000Z'
                created_by: 1
                name: Joe Bloggs
                project_id: 1
                default_folder_id: 1
                media_type: application/pdf
                state: active
                options: {}
        '404':
          description: Not found
    servers:
    - url: https://{moniker}.app.luminance.com
      description: Your Luminance instance
      variables:
        moniker:
          default: your-instance
          description: Instance moniker (e.g. acme)
  /api2/projects/{project_id}/document_templates/{document_template_id}/fields:
    get:
      tags:
      - Document Templates
      summary: Get document template fields (for contract creation)
      parameters:
      - $ref: '#/components/parameters/projectId'
      - in: path
        name: document_template_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: 1
                created_at: '2024-01-15T12:00:00.000Z'
                created_by: 1
                name: Joe Bloggs
                key: example_key
                field_order: 0
                document_template_id: 1
                parent_data_field_id: 1
                datatype: string
                options: {}
                type: document
                conditions: {}
    servers:
    - url: https://{moniker}.app.luminance.com
      description: Your Luminance instance
      variables:
        moniker:
          default: your-instance
          description: Instance moniker (e.g. acme)
  /api2/projects/{project_id}/document_templates/create:
    post:
      tags:
      - Document Templates
      summary: Create contract (matter + generated document from template)
      description: Get template fields from GET .../document_templates/{id}/fields; the data object keys match field keys (e.g. singleInputFieldKey for type datatag). For nested/loop fields use arrays of objects. See docuvault Contract Creation and Postman Contract Generation collection.
      parameters:
      - $ref: '#/components/parameters/projectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentTemplateCreateRequest'
      responses:
        '201':
          description: Created
        '422':
          description: Validation error
    servers:
    - url: https://{moniker}.app.luminance.com
      description: Your Luminance instance
      variables:
        moniker:
          default: your-instance
          description: Instance moniker (e.g. acme)
components:
  schemas:
    DocumentTemplateCreateRequest:
      type: object
      description: Payload for POST document_templates/create (contract creation). Get field keys from GET .../document_templates/{id}/fields; pass values in data keyed by field keys (e.g. singleInputFieldKey from fields of type datatag).
      properties:
        document_template_id:
          type: integer
        data:
          type: object
          description: Key-value map of template field keys to values
        name:
          type: string
        state:
          type: string
        workflow_id:
          type: integer
      required:
      - document_template_id
      - data
    DocumentTemplate:
      type: object
      description: Document template for contract generation (see API2_Schema document_templates table)
      properties:
        id:
          type: integer
        created_at:
          type: string
          format: date-time
        created_by:
          type: integer
        name:
          type: string
        project_id:
          type: integer
        default_folder_id:
          type: integer
        media_type:
          type: string
        state:
          type: string
        options:
          type: object
  parameters:
    projectId:
      in: path
      name: project_id
      required: true
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Access token from the OAuth2 client credentials flow. See the Authentication section above for how to obtain a token (curl to your instance token endpoint); then paste the access_token here.

        '
x-refined-from:
- luminance-document-templates-api-openapi.yml
- luminance-public-api-v2-openapi-original.yml