DottedSign Download API

openapi: 3.2.0
info:
  title: Dottedsign Com Download API
  version: 1.0.0
  description: 'Operations tagged Download across 3 of this provider''s published API definitions: dottedsign-com-filemissions-api-openapi.yml, dottedsign-com-publicforms-api-openapi.yml, dottedsign-com-signtasks-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dottedsign.com
tags:
- name: Download
paths:
  /v1/file_missions/download_link:
    get:
      operationId: getFileMissionDownloadLink
      summary: Get a file mission download link
      description: Get download link of a file mission related files.
      tags:
      - Download
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - name: file_mission_id
        description: File Mission ID.
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: '200'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '366'
          content:
            application/json:
              schema:
                type: object
                title: FileMissionDownloadLink
                description: File mission download link.
                properties:
                  data:
                    type: object
                    description: Download link of related files.
              example:
                data:
                  merge_completed: https://bucket.s3.us-stubbed-1.amazonaws.com/file?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20261005%2Fus-stubbed-1%2Fs3%2Faws4_request&X-Amz-Date=20261005T035044Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=4ff857ffb0b8440e7aec1781b1042c83313556abf4d6fc80e0568a7189929cef
        '403':
          description: '403'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '121'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 403067
                error_message: file merge mission not accessible
                error_key: file_merge_mission_not_accessible
        '404':
          description: '404'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '111'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 404054
                error_message: file merge mission not found
                error_key: file_merge_mission_not_found
    servers:
    - url: https://api.dottedsign.com
  /v1/public_forms/download_csv:
    get:
      operationId: downloadPublicFormCsv
      summary: Download the CSV of public form
      description: Download the CSV file of all tasks created from the public form.
      tags:
      - Download
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/AcceptCsv'
      - name: form_id
        description: Form ID.
        in: query
        required: true
        schema:
          type: integer
      - name: zone
        description: Timezone.
        in: query
        schema:
          type: integer
      - name: search_keys[]
        description: Field search keys.
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          headers:
            content-type:
              schema:
                type: string
                example: text/csv; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '192'
          content:
            text/csv:
              schema:
                type: string
                format: binary
              examples:
                example-0:
                  summary: '200'
                  value: "\uFEFFTask ID,Task Name,Created Time,Form Signer 1 Name,Form Signer 1 Email,search_key_462,search_key_485\n58,Test Form 1-PublicForm-Test 1,2026-10-05 03:51:14 UTC,Test 1,test1@test.com,text,text\n"
        '400':
          description: '400'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '92'
          content:
            application/json:
              schema:
                type: object
              examples:
                example-0:
                  summary: 400_915 (form_is_deleted)
                  value:
                    error_code: 400915
                    error_message: public form is deleted
                    error_key: form_is_deleted
                example-1:
                  summary: 400_918 (form_should_unpublish)
                  value:
                    error_code: 400918
                    error_message: public form should be unpublish
                    error_key: form_should_unpublish
        '403':
          description: '403'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '100'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 403901
                error_message: member not owner of public form
                error_key: form_not_owned
        '404':
          description: '404'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '90'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 404043
                error_message: public form not found
                error_key: form_not_found
    servers:
    - url: https://api.dottedsign.com
  /v1/sign_tasks/download:
    get:
      operationId: downloadSignTask
      summary: Download task related files
      description: Download task related files into a zip file.
      tags:
      - Download
      parameters:
      - $ref: '#/components/parameters/AcceptZip'
      - $ref: '#/components/parameters/OptionalAuthorization'
      - $ref: '#/components/parameters/Code'
      - name: task_id
        description: Task ID.
        in: query
        required: true
        schema:
          type: integer
      - name: file_types[]
        description: 'File types.

          *Available file types include `task`, `attachment`, `attachment_compressed`, `audit_trail`, and `source_file`.*

          Availability depends on task status. `task` returns the original document before the task is completed and the signed file afterward. `attachment` and `attachment_compressed` require a completed task, and `audit_trail` requires a completed, declined, or voided task.

          '
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          headers:
            content-type:
              schema:
                type: string
                example: application/zip
            content-length:
              schema:
                type: integer
                example: '1395'
          content:
            application/zip:
              schema:
                type: string
                format: binary
              examples:
                example-0:
                  summary: '200'
                  value: "PK0E]©Ìévõ\x82normal.pdf.pdf­\x97ÍSÛ8\x87ïþ+ta¦\x90õé\x8FN§3\x9A\x96iw`\x87\x9Da8\x98DPÓÄî:Îö¯_Éz#Þ@\t\x87D?ùA\x92eé±rpq:9âT&\x920ÒÞ>$>¤WO¿I/ª{\x93ØÏÎ4=áöê4I§fÕ®»\x99Yá+NÚ¦·×WD¹üñcb\x9A¹kE\x8D­}7Í}ÿ\x83pY{}Õw¦Z&\x8Cê\x9CüNùb\x8B\x8C\x91ñcú%á\x94K{Qg4+I^jªY­Í³M^\x90ËM#Àåö²\x888\x9F1§m7:â|Æ\x9CÈ©Ì#ÎgÌ1å¾FÎgÄe\N ,dÌé\x92Jq>cNÚ¯,â|Æ\x97´,\"ÎgÄéÒ®>r\x901\x974\x93ç3æ\x94¦e4Ï\x901'$Ñø c\x8E1\x9AEë2âT\x9EÓ2\x9AgÈ\x98Ó\x9A\x8Ah\x9E!cN\nGÎg̱\x92Ñ:\x80\x8C8YäTDós\x99¢:dÌ)N\x8Bh@Æ/)\x8Fæ2âD\x99QÍ3dÌå\x92Ñ:\x80\x8C9m·s´ cNTEósLÓ\"\x9FÏ\x88ã\N¤<Z\x901\x971ª¢y\x86\x8C9\x99»Ë#ç3渦,Z\x90W\nª¢eà#Þ½%Í£IöÑQÏ©rʲxÉ»è(kc.xYïfùì¹å³=X^Ùí$\"ËË\x82êb\x8Bå\x81\x96Y¸`yà\x90å\x81\x96Y¸`yà\x90å=7ZÞsØòÀË\x87,\\°<pÈòÀË\x87,ï¹Ñò\x9EÃ\x96.X8dyà\x82å\x81C\x96.X8dyà\x82å\x81C\x96÷ÜhyÏaË,²<pÁòÀ!Ë,²¼çFË{[¸`yà\x90å\x81\x96Y¸`yà\x90å=7ZÞsØòÀË\x87,\\°<pÈòÀË\x87,\\°<pÈò\x9E-ï9lyà\x82å\x81C\x96.X8dyà\x82å\x81C\x96÷\\°¼Ç\x90åa÷n,\x9B÷¥å7k,¿Yò¯Z\x9Eo³ü*I¿Õó¹v'ý)ÑÃç\x8D\x93ûÚª_$é_f^WÇí#¹¶\x92¶fÐn\x87n¡\x957É(ý|lü¸Z\x99\x89}7¤_Íâ_Ó׳jè/uuIú¹\x99µóº¹O/ûª\x99WÝ|S\x91¤\x97ëÛÞ\x81\x8EæcÓÅ[M·\x8Bùní\x97o¶~»¨ÿY\x9Bݺàì\x8F÷°\x9F~ø\x96~ì£ìjÓíزx½å=<.ßh~?S£þpûéEoéåª^\x9AÕÑ´]VÍ\x8E­g¯¶¾\x87G°mûÆÏújQÏvl~Û6Ǿ\x8F.Æ%jÏ®];»4=¹N/N'$½2\x8F=IÏ\x96ÖxÇð}ßgÖv®GâþmÂIîO·A\n(IRBI\x91a'»¢&Æ{\x9C\x87#ñ$'ÃJvE«E{þ×P´ÿ?<Å¡Ì\tßôÆÝ[k(ÛûIÿ>¿}0³aH6F\x93X>¿Åùzf:òîaån\x92S{\x9A=ê»uóó0±SÛ/yw8ÌÖÐ\x98+Z÷?Ún(~3O¿ÛΪß\Nû¢èáÂP®Ûæ´êm§ï\x9Cq^Ø·(ãùa4Á¢áøwÊIed{\x9Fø\x97Ëæ·Ãù/Ó|\x9A¹F7/\x9AtR÷_I³^,n<û½zj×ö\x9D7æ¤]¬\x97MÔÏcgîìïÁþìáXKMîÔI&ìäW\x9AM\x9Dyñ²Îþ!\x8E±\"YÇ5G×%â$Õ\t·\n^ÔIܯT\x8DOj\x8EÛËØ\x96º-c±?\x90P]±\N+K\x8Eæ\x8A\nÕñÏ©f\x98ËTÔGßUõÂt⸬ÿ3î¹¥Ó¶µÇ\tØ<gÍ]Kx¹Yêúá«\\óäààóùäPK?0E]©Ìévõ\x82¤\x81normal.pdf.pdfPK<!"
        '400':
          description: '400'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '90'
          content:
            application/json:
              schema:
                type: object
              examples:
                example-0:
                  summary: 400_035 (task_not_waiting)
                  value:
                    error_code: 400035
                    error_message: task is not waiting
                    error_key: task_not_waiting
                example-1:
                  summary: 400_417 (invalid_params)
                  value:
                    error_code: 400417
                    error_message: 'Input parameters are invalid: {error_message: "invalid file_types: anything"}'
                    error_key: invalid_params
                example-2:
                  summary: 400_066 (no_compressible_files)
                  value:
                    error_code: 400066
                    error_message: 'no compressible files: no_compressible_files'
                    error_key: no_compressible_files
        '403':
          description: '403'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '96'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 403036
                error_message: task is not accessible
                error_key: task_not_accessible
    servers:
    - url: https://api.dottedsign.com
  /v1/sign_tasks/download_link:
    get:
      operationId: getSignTaskDownloadLink
      summary: Get a task download link
      description: Get download link of a task related files.
      tags:
      - Download
      parameters:
      - $ref: '#/components/parameters/OptionalAuthorization'
      - $ref: '#/components/parameters/Code'
      - name: task_id
        description: Task ID.
        in: query
        required: true
        schema:
          type: integer
      - name: file_types[]
        description: 'File types.

          *Available file types include `task`, `attachment`, `attachment_compressed`, `audit_trail`, and `source_file`.*

          Availability depends on task status. `task` returns the original document before the task is completed and the signed file afterward. `attachment` and `attachment_compressed` require a completed task, and `audit_trail` requires a completed, declined, or voided task.

          '
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '1420'
          content:
            application/json:
              schema:
                type: object
                title: SignTaskDownloadLink
                description: Sign task download link.
                properties:
                  data:
                    type: object
                    description: Download link of all request file types.
              examples:
                example-0:
                  summary: '200'
                  value:
                    data:
                      task: https://bucket.s3.us-stubbed-1.amazonaws.com/file?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20261005%2Fus-stubbed-1%2Fs3%2Faws4_request&X-Amz-Date=20261005T035321Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=b3ed1ceed300cdc09237cf41f7b7025d245dd457b8ffb226cb7a5001e28f8a9f
                      attachment: https://bucket.s3.us-stubbed-1.amazonaws.com/file?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20261005%2Fus-stubbed-1%2Fs3%2Faws4_request&X-Amz-Date=20261005T035321Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=b3ed1ceed300cdc09237cf41f7b7025d245dd457b8ffb226cb7a5001e28f8a9f
                      attachment_compressed: https://bucket.s3.us-stubbed-1.amazonaws.com/file?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20261005%2Fus-stubbed-1%2Fs3%2Faws4_request&X-Amz-Date=20261005T035321Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=b3ed1ceed300cdc09237cf41f7b7025d245dd457b8ffb226cb7a5001e28f8a9f
                      audit_trail: https://bucket.s3.us-stubbed-1.amazonaws.com/file?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20261005%2Fus-stubbed-1%2Fs3%2Faws4_request&X-Amz-Date=20261005T035321Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=b3ed1ceed300cdc09237cf41f7b7025d245dd457b8ffb226cb7a5001e28f8a9f
        '400':
          description: '400'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '148'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 400417
                error_message: 'Input parameters are invalid: {error_message: "invalid file_types: anything"}'
                error_key: invalid_params
        '403':
          description: '403'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '96'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 403036
                error_message: task is not accessible
                error_key: task_not_accessible
    servers:
    - url: https://api.dottedsign.com
components:
  parameters:
    Authorization:
      name: Authorization
      description: OAuth2 Bearer token.
      in: header
      required: true
      schema:
        type: string
        example: Bearer {{token}}
    AcceptCsv:
      name: Accept
      description: Accept json or csv.
      in: header
      schema:
        type: string
        default: application/json text/csv
    AcceptZip:
      name: Accept
      description: Accept json or zip.
      in: header
      schema:
        type: string
        default: application/json application/zip
    Code:
      name: Code
      description: "JWT code for quick sign authentication. Use it instead of the `Authorization` bearer token to read or sign a task on behalf of a signer who is not a DottedSign member.\n\nThe [Get the share link](ref:getsigntasksharelink) API returns a `share_link` such as `https://www.dottedsign.com/task?code=eyJhbGciOiJIUzUxMiJ9...`. \n\nJWT code is the value of that URL's `code` query parameter; it is not returned as a separate field in the response.\n\nQuick sign authentication is only available to signers who do not have a DottedSign account. If the signer is a registered DottedSign member, the request is rejected with the `login_required` (`401_030`) error and the signer must sign in to read and sign the task, no matter how the quick sign setting is configured.\n"
      in: header
      required: false
      schema:
        type: string
        example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHBpcmVkX3N0YW5kYXJkX2lkIjoxLCJleHBpcmVkX3N0YW5kYXJkX3R5cGUiOiJ0ZXh0IiwiaWF0IjoxNjM0NzQwNjQ4LCJleHAiOjE2MzQ3NDA2NDh9.1
    OptionalAuthorization:
      name: Authorization
      description: OAuth2 Bearer token.
      in: header
      schema:
        type: string
        example: Bearer {{token}}
x-refined-from:
- dottedsign-com-filemissions-api-openapi.yml
- dottedsign-com-publicforms-api-openapi.yml
- dottedsign-com-signtasks-api-openapi.yml
x-provenance:
  method: searched
  source: https://developer.dottedsign.com/reference
  harvested: '2026-11-05'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.dottedsign.com/reference/createfilemission.md
  - https://developer.dottedsign.com/reference/getfilemission.md
  - https://developer.dottedsign.com/reference/getfilemissiondownloadlink.md
  - https://developer.dottedsign.com/reference/renewfilemission.md
  merge:
    pages: 4
    deduped: 7
    conflicts_kept_first: 0