Concord Automated Template API

openapi: 3.2.0
info:
  x-logo:
    url: https://www.concord.app/wp-content/uploads/2025/01/Logo-full-color-16px-padding.svg
  title: Concord Automated Template API
  description: '## Overview


    ### Basics


    Concord, https://www.concord.app/, is a cloud-based contract lifecycle management platform built for all types of businesses.

    It provides unlimited e-signatures and unlimited contract storage for any number of users.

    Concord saves time, money, and trees. It’s a smart way to get everyone to agree.


    This Concord API gives you access to features you see in Concord and lets you extend them for use in your own application.

    It strives to be RESTful and is organized around the main resources you’re familiar with from the Concord interface.


    Before you do anything, you should get a Concord account on our sandbox environment that you can test the API against

    and create an API Key so that you can make API calls.


    ### Format


    Both request body data and response data are formatted as JSON.


    ### Upcoming changes


    We are always maintaining, fixing, and enhancing our API. As such, you should expect new endpoints to show up, new fields to be added to responses and new error codes to appear.

    We recommend that you build your code to gracefully ignore things that you aren’t expecting, and to handle errors in standard HTTP-centric ways.


    ### Getting help


    To get in touch with our API experts directly, please send a message to support@concord.app.


    ## Environments


    The API is accessible from:


    + https://uat.concordnow.com/api/rest/1/ - sandbox


    + https://api.concordnow.com/api/rest/1/ - production


    ## Authentication


    To use this API, you need to be authenticated.


    ### With an API key


    Users authenticate themselves through the HTTP Header **X-API-KEY**.

    You can generate as many API Keys as needed from your Concord account.


    If the HTTP Header is missing or if the API Key is invalid,

    the HTTP Response will be 401 Unauthorized.


    ## Errors


    The API communicates errors through standard HTTP status codes paired with error objects. Generally, the following pattern will apply:


    + 2xx - The request was successfully received, understood, and accepted.


    + 4xx - An error in the request. Usually a bad parameter.


    + 5xx - The request is fine, but something is wrong on Concord''s end.


    ### 4xx errors definition


    The errors referenced here are valid for most (or even all) of our endpoints.

    They are standard error messages for things like "Not authenticated, but you should" or "You can''t access this".

    Depending on what you''re trying to access, you might get a bit more information in the response.


    + Response 400 (application/json)


    {

    "statusCode": 400,

    "restCode": "badRequest"

    }


    + Response 401 (application/json)


    {

    "statusCode": 401,

    "restCode": "authFailed"

    }


    + Response 403 (application/json)


    {

    "statusCode": 403,

    "restCode": "accessDenied"

    }


    + Response 404 (application/json)


    {

    "statusCode": 404,

    "restCode": "notFound"

    }


    + Response 409 (application/json)


    {

    "statusCode": 409,

    "restCode": "conflict"

    }


    ### HTTP status code


    + 200 success


    + 201 created


    + 202 accepted


    + 204 no_content


    + 400 bad_request


    + 401 unauthorized


    + 403 forbidden


    + 404 not_found


    + 405 method_not_allowed


    + 409 conflict


    + 415 unsupported_media_type


    + 500 internal_server_error


    + 502 bad_gateway


    + 503 unavailable


    + 504 gateway_timeout'
  contact:
    email: support@concord.app
    name: Support Concord
    url: https://help.concord.app/
  license:
    name: Terms of service
    url: https://www.concord.app/terms-of-service
  version: Concord API v1.0
servers:
- url: https://uat.concordnow.com/api/rest/1
  variables: {}
security:
- ApiKeyAuthentication: []
tags:
- name: Automated Template
  description: 'Once you have created an automated template in Concord,

    you can then create and customize contracts to send out for collaboration and signature.

    You can designate which content will be variable.

    Variables appear in blue in Concord and will be updated with data particular to each contract.


    More information here.'
paths:
  /organizations/{organizationId}/auto:
    get:
      tags:
      - Automated Template
      summary: List Automated Templates from an organization
      description: ''
      operationId: ListAutomatedTemplates
      parameters:
      - in: path
        name: organizationId
        description: Organization ID
        required: true
        schema:
          type: integer
          format: int64
      - name: organizationId
        in: query
        description: Organization ID (alternative to path parameter)
        required: false
        schema:
          type: integer
          format: int64
      - name: salesforceReady
        in: query
        description: Retrieves automated templates compatible with Salesforce integration.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListAutomatedTemplatesresponse'
                description: ''
  /organizations/{organizationId}/auto/{agreementUid}:
    post:
      tags:
      - Automated Template
      summary: Use an Automated Template
      description: ''
      operationId: UseanAutomatedTemplate
      parameters:
      - in: path
        name: organizationId
        description: Organization ID
        required: true
        schema:
          type: integer
          format: int64
          example: 1
      - name: agreementUid
        in: path
        description: Automated Template UID.
        required: true
        schema:
          $ref: '#/components/schemas/AgreementUid'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UseanAutomatedTemplaterequest'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseanAutomatedTemplateresponse'
components:
  schemas:
    Variables:
      title: Variables
      type: object
      additionalProperties:
        type: string
      example:
        Account.AccountNumber: 3568928
        Account.Site: My Account Site
        MyFirstVariable: Value to replace the variable with
    UseanAutomatedTemplateresponse:
      title: UseanAutomatedTemplateresponse
      required:
      - uid
      - title
      - description
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/AgreementUid'
        title:
          type: string
          description: Agreement title
        description:
          description: Agreement summary description
          type: string
          example: This NDA covers the company for 10 years.
    AgreementUid:
      oneOf:
      - type: string
        minLength: 22
        maxLength: 22
        description: Concord agreement unique identifier. (new format)
      - type: string
        minLength: 6
        maxLength: 6
        description: Concord agreement unique identifier. (old format)
      examples:
      - 01sp9L4YEZNcLHaSV8447N
      - G4VIX7
    UseanAutomatedTemplaterequest:
      title: UseanAutomatedTemplaterequest
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        tags:
          type: array
          items:
            type: string
          description: ''
        signatureRequired:
          type: integer
          format: int32
        variables:
          $ref: '#/components/schemas/Variables'
        inviteNowEmails:
          $ref: '#/components/schemas/InviteNowEmails'
        inviteLaterEmails:
          $ref: '#/components/schemas/InviteLaterEmails'
        sendWithDocument:
          type: boolean
        customMessageName:
          type: string
        customMessageTitle:
          type: string
        customMessageContent:
          type: string
      example:
        title: Non-Disclosure Agreement with Alembic Inc.
        description: This NDA covers the company for 10 years.
        tags:
        - Monday
        - Thursday
        signatureRequired: 2
        variables:
          Account.AccountNumber: 3568928
          Account.Site: My Account Site
          MyFirstVariable: Value to replace the variable with
        inviteNowEmails:
          a@corp.com: FULL
          b@corp.com: FULL
          c@corp.com: LIMITED
          d@partner.com: NO_EDIT
        inviteLaterEmails:
          e@corp.com: FULL
          f@company.com: LIMITED
          g@enterprise.com: LIMITED
          h@corp.com: NO_EDIT
        sendWithDocument: true
        customMessageName: Name of custom message
        customMessageTitle: Title of custom message
        customMessageContent: Content of custom message
    ListAutomatedTemplatesresponse:
      title: ListAutomatedTemplatesresponse
      required:
      - uid
      - title
      - description
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/AgreementUid'
        title:
          type: string
          example: Non-Disclosure Agreement
        description:
          type: string
          example: This NDA covers the company for 10 years.
    InviteNowEmails:
      title: InviteNowEmails
      type: object
      additionalProperties:
        type: string
      example:
        a@corp.com: FULL
        b@corp.com: FULL
        c@corp.com: LIMITED
        d@partner.com: NO_EDIT
    InviteLaterEmails:
      title: InviteLaterEmails
      type: object
      additionalProperties:
        type: string
      example:
        e@corp.com: FULL
        f@company.com: LIMITED
        g@enterprise.com: LIMITED
        h@corp.com: NO_EDIT
  securitySchemes:
    ApiKeyAuthentication:
      type: apiKey
      in: header
      name: X-API-KEY
      description: 'Users authenticate themselves through the HTTP Header X-API-KEY. You can generate as many API Keys as needed from your Concord account.

        If the HTTP Header is missing or if the API Key is invalid, the HTTP Response will be 401 Unauthorized.'
x-provenance:
  method: harvested
  publisher: Concord
  source: https://api.doc.concordnow.com/concord-openapi-bundled.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)