Docusign EnvelopeFormData API

openapi: 3.2.0
info:
  title: Docusign Envelope Form Data API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged EnvelopeFormData across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: EnvelopeFormData
  description: The EnvelopeFormData resource provides methods that manage forms in an envelope.
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/form_data:
    get:
      tags:
      - EnvelopeFormData
      summary: Docusign Returns envelope form data for an existing envelope
      operationId: FormData_GetFormData
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/envelopeFormData'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getFormData
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data:
    parameters: []
    get:
      tags:
      - EnvelopeFormData
      summary: Returns envelope tab data for an existing envelope
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdFormData
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/envelopeFormData_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getFormData
      description: 'This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.


        **Note:** To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account.


        ### Related topics


        - How to get envelope tab values'
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: FormData_GetFormData
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    envelopeFormData:
      type: object
      properties:
        emailSubject:
          type: string
          description: 'Specifies the subject of the email that is sent to all recipients.


            See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.'
        envelopeId:
          type: string
          description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        formData:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/nameValue'
        prefillFormData:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/nameValue'
        recipientFormData:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/recipientFormData'
        sentDateTime:
          type: string
          description: The UTC DateTime when the envelope was sent. Read only.
        status:
          type: string
          description: Item status. <!-- TODO -->
      description: ''
      x-ds-definition-name: envelopeFormData
      x-ms-summary: ''
    nameValue:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        name:
          type: string
          description: The name or key of a name/value pair.
        originalValue:
          type: string
          description: 'The initial value of the tab when it was sent to the recipient. '
        value:
          type: string
          description: The value field of a name/value pair.
      description: ''
      x-ds-definition-name: nameValue
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    recipientFormData:
      type: object
      properties:
        declinedTime:
          type: string
          description: ''
        deliveredTime:
          type: string
          description: ''
        email:
          type: string
          description: ''
        formData:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/nameValue'
        name:
          type: string
          description: ''
        recipientId:
          type: string
          description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
        sentTime:
          type: string
          description: ''
        signedTime:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: recipientFormData
      x-ms-summary: ''
    prefillFormData:
      type: object
      properties:
        formData:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/formDataItem'
        senderEmail:
          description: The sender's email address.
          type: string
        senderName:
          description: The sender's name.
          type: string
        senderUserId:
          description: The ID of the sender.
          type: string
      x-ds-definition-name: prefillFormData
      description: ''
      x-ms-summary: ''
    recipientFormData_2:
      type: object
      properties:
        DeclinedTime:
          description: The date and time the recipient declined the envelope.
          type: string
        DeliveredTime:
          description: The date and time the recipient viewed the documents in the envelope in the Docusign signing UI.
          type: string
        email:
          description: The recipient's email address.
          type: string
        formData:
          description: An array of form data objects.
          type: array
          items:
            $ref: '#/components/schemas/formDataItem'
        name:
          description: The name of the recipient.
          type: string
        recipientId:
          description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
          type: string
        SentTime:
          description: The date and time the envelope was sent to the recipient.
          type: string
        SignedTime:
          description: The date and time the recipient signed the documents.
          type: string
      x-ds-definition-name: recipientFormData
      description: ''
      x-ms-summary: ''
    envelopeFormData_2:
      type: object
      properties:
        emailSubject:
          description: 'The subject line of the email message that is sent to all recipients.


            For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).


            **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.

            '
          type: string
        envelopeId:
          description: The envelope ID of the envelope status that failed to post.
          type: string
        formData:
          description: "An array of `formDataItem` objects. \n"
          type: array
          items:
            $ref: '#/components/schemas/formDataItem'
        prefillFormData:
          $ref: '#/components/schemas/prefillFormData'
          description: 'An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs). '
        recipientFormData:
          description: An array of form data for each recipient of the envelope.
          type: array
          items:
            $ref: '#/components/schemas/recipientFormData_2'
        sentDateTime:
          description: The UTC DateTime when the envelope was sent. This property is read-only.
          type: string
        status:
          description: "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
          type: string
      description: Describes the form data of the envelope.
      x-ds-definition-name: envelopeFormData
      x-ms-summary: Describes the form data of the envelope.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    formDataItem:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        listSelectedValue:
          description: The selected value in a list.
          type: string
        name:
          description: The name of the form field.
          type: string
        numericalValue:
          description: ''
          type: string
        originalNumericalValue:
          description: ''
          type: string
        originalValue:
          description: The initial value associated with the form field.
          type: string
        value:
          description: The current value associated with the form field.
          type: string
      x-ds-definition-name: formDataItem
      description: ''
      x-ms-summary: ''
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'