DottedSign Sign Task API

openapi: 3.2.0
info:
  title: Groups Sign Task API
  description: The Open API for DottedSign.
  version: 1.0.0
servers:
- url: https://api.dottedsign.com
tags:
- name: SignTask
paths:
  /v1/groups/sign_tasks/list:
    get:
      operationId: getGroupSignTasksList
      summary: Get group task list
      description: Get group task list.
      tags:
      - SignTask
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - $ref: '#/components/parameters/has_order'
      - $ref: '#/components/parameters/field_key'
      - $ref: '#/components/parameters/field_value'
      - $ref: '#/components/parameters/metadata_key'
      - $ref: '#/components/parameters/metadata_value'
      - $ref: '#/components/parameters/file_name'
      - $ref: '#/components/parameters/signer'
      - name: status
        description: Task status.
        in: query
        schema:
          type: string
          default: waiting
          enum:
          - all
          - draft
          - waiting
          - completed
          - declined
          - voided
          - expired
      - name: emails[]
        description: Emails of group members.
        in: query
        schema:
          type: array
          items:
            type: string
      - name: template_id
        description: Template ID.
        in: query
        schema:
          type: integer
      - name: start_from
        description: Last updated timestamp that query start from. Should use with `end_at`.
        in: query
        schema:
          type: integer
      - name: end_at
        description: Last updated timestamp that query end at. Should use with `start_from`.
        in: query
        schema:
          type: integer
      - name: sort_type
        description: Sort type.
        in: query
        schema:
          type: string
          default: updated_at
          enum:
          - created_at
          - updated_at
          - modified_at
      - name: order_by
        description: Order by.
        in: query
        schema:
          type: string
          default: desc
          enum:
          - asc
          - desc
      responses:
        '200':
          description: '200'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '3963'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignTaskList'
              examples:
                example-0:
                  summary: '200'
                  value:
                    data:
                      total_count: 2
                      current_page: 1
                      total_pages: 1
                      tasks:
                      - task_id: 4
                        file_name: my_draft.pdf
                        sign_type: create_and_invite
                        has_order: true
                        status: waiting
                        last_modified_at: 1791172251
                        last_modified_by_owner: false
                        owned_by_me: false
                        access_info:
                          view: true
                          sign: true
                          edit: false
                          review: false
                          decline: true
                          confirm: false
                          update: false
                          forward: true
                          forward_request: false
                          preview_attachments: true
                          download: true
                          download_audit_trail: false
                          void: false
                          delete: false
                          restore: false
                          share_sign_link: false
                          archive: false
                          dearchive: false
                          save_template: false
                          resend: false
                          consent_file: true
                          ai_summary: false
                          download_attachments: false
                          download_source_files: true
                        current_stage_infos:
                        - stage_id: 8
                          email: group@test.com
                          name: Group Member
                        details:
                        - name: Mike
                          email: me@test.com
                          sequence: 0
                          status: sent
                        - stage_id: 7
                          sequence: 1
                          status: done
                          stage_type: sign
                          email: ada@test.com
                          name: Ada
                        - stage_id: 8
                          sequence: 2
                          status: processing
                          stage_type: sign
                          email: group@test.com
                          name: Group Member
                        task_setting:
                          deadline: 1793850651
                          forget_remind: true
                          expire_remind: true
                          expires_in_days: 31
                          receiver_lang: en
                          owner_informable: true
                          ai_summary: true
                          link_expire_days: 2
                          forget_remind_days: 2
                          remind_days_before_expire: 31
                          cc_infos:
                          - email: cc@test.com
                            name: Member in CC
                            viewable_source_files: null
                          message: null
                          completed_message: null
                          reference_settings:
                          - reference_id: reference_1
                            reference_type: reference_type
                            file_name: reference.pdf
                            force: true
                            viewable_in_processing: true
                          - reference_id: reference_2
                            reference_type: completed_reference_type
                            file_name: completed_reference.pdf
                            force: false
                            viewable_in_processing: false
                          completed_reference_settings:
                          - reference_id: reference_2
                            reference_type: completed_reference_type
                            file_name: completed_reference.pdf
                            force: false
                            viewable_in_processing: false
                        metadata: {}
                        created_at: 1791172251
                      - task_id: 3
                        file_name: my_draft.pdf
                        sign_type: create_and_invite
                        has_order: true
                        status: waiting
                        last_modified_at: 1791172251
                        last_modified_by_owner: false
                        owned_by_me: false
                        access_info:
                          view: true
                          sign: true
                          edit: false
                          review: false
                          decline: true
                          confirm: false
                          update: false
                          forward: true
                          forward_request: false
                          preview_attachments: true
                          download: true
                          download_audit_trail: false
                          void: false
                          delete: false
                          restore: false
                          share_sign_link: false
                          archive: false
                          dearchive: false
                          save_template: false
                          resend: false
                          consent_file: true
                          ai_summary: false
                          download_attachments: false
                          download_source_files: true
                        current_stage_infos:
                        - stage_id: 6
                          email: group@test.com
                          name: Group Member
                        details:
                        - name: Mike
                          email: me@test.com
                          sequence: 0
                          status: sent
                        - stage_id: 5
                          sequence: 1
                          status: done
                          stage_type: sign
                          email: ada@test.com
                          name: Ada
                        - stage_id: 6
                          sequence: 2
                          status: processing
                          stage_type: sign
                          email: group@test.com
                          name: Group Member
                        task_setting:
                          deadline: 1793850651
                          forget_remind: true
                          expire_remind: true
                          expires_in_days: 31
                          receiver_lang: en
                          owner_informable: true
                          ai_summary: true
                          link_expire_days: 2
                          forget_remind_days: 2
                          remind_days_before_expire: 31
                          cc_infos:
                          - email: cc@test.com
                            name: Member in CC
                            viewable_source_files: null
                          message: null
                          completed_message: null
                          reference_settings:
                          - reference_id: reference_1
                            reference_type: reference_type
                            file_name: reference.pdf
                            force: true
                            viewable_in_processing: true
                          - reference_id: reference_2
                            reference_type: completed_reference_type
                            file_name: completed_reference.pdf
                            force: false
                            viewable_in_processing: false
                          completed_reference_settings:
                          - reference_id: reference_2
                            reference_type: completed_reference_type
                            file_name: completed_reference.pdf
                            force: false
                            viewable_in_processing: false
                        metadata: {}
                        created_at: 1791172250
        '403':
          description: '403'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '169'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 403056
                error_message: 'group is not accessible: member do not have accessibility correspond to action view_team_tasks'
                error_key: group_not_accessible
        '404':
          description: '404'
          headers:
            content-type:
              schema:
                type: string
                example: application/json; charset=utf-8
            content-length:
              schema:
                type: integer
                example: '85'
          content:
            application/json:
              schema:
                type: object
              example:
                error_code: 404205
                error_message: group not found
                error_key: group_not_found
components:
  parameters:
    field_value:
      name: field_value
      description: Field value. *Required if `field_key` is provided.*
      in: query
      schema:
        type: string
    has_order:
      name: has_order
      description: Signers should sign sequentially or not.
      in: query
      schema:
        type: boolean
    Authorization:
      name: Authorization
      description: OAuth2 Bearer token.
      in: header
      required: true
      schema:
        type: string
        example: Bearer {{token}}
    metadata_value:
      name: metadata_value[]
      description: Metadata value. Must have the same number of elements as `metadata_key`. *Required if `metadata_key` is provided.*
      in: query
      schema:
        type: array
        items:
          type: string
        maxItems: 10
    field_key:
      name: field_key
      description: Field key. *Required if `field_value` is provided.*
      in: query
      schema:
        type: string
    signer:
      name: signer
      description: Signer's email or name.
      in: query
      schema:
        type: string
    metadata_key:
      name: metadata_key[]
      description: Metadata key. Use with `metadata_value` to filter by key-value pairs using AND semantics. Up to 10 pairs allowed. *Required if `metadata_value` is provided.*
      in: query
      schema:
        type: array
        items:
          type: string
        maxItems: 10
    per_page:
      name: per_page
      description: Number of items per page.
      in: query
      required: false
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 20
    file_name:
      name: file_name
      description: Task name.
      in: query
      schema:
        type: string
    page:
      name: page
      description: Page number.
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
  schemas:
    DummyStage:
      type: object
      properties:
        stage_id:
          type: integer
          description: Stage ID.
        role:
          type: string
          description: Signer's role.
        email:
          type: string
          description: Actor's email.
        stage_type:
          type: string
          description: Stage type.
          enum:
          - sign
          - edit
          - form_sign
        sequence:
          type: integer
          description: Stage sequence, which starts from `1`.
        status:
          type: string
          description: Stage status.
          enum:
          - initial
          - processing
          - signed
          - done
          - modifying
          - reviewed
          - declined
          - canceled
      description: Dummy stage.
    SignTaskList:
      type: object
      properties:
        data:
          type: object
          properties:
            total_count:
              type: integer
              description: Total count of items.
            current_page:
              type: integer
              description: Current page number.
            total_pages:
              type: integer
              description: Total page count.
            tasks:
              type: array
              items:
                $ref: '#/components/schemas/SignTask'
      description: Sign task list.
    SourceSettingReferenceSetting:
      type: object
      description: Source setting reference setting.
      properties:
        file_name:
          type: string
          description: Reference name.
        reference_id:
          type: string
          description: Reference ID.
        reference_type:
          type: string
          description: Reference file type.
        force:
          type: boolean
          description: Force signers to consent to the file or not.
        viewable_in_processing:
          type: boolean
          description: Signers can view the file or not before the task is completed.
    SignTaskAccessInfo:
      type: object
      description: Sign task access info.
      properties:
        view:
          type: boolean
          description: Member can view the task or not.
        sign:
          type: boolean
          description: Member can sign the task or not.
        review:
          type: boolean
          description: Member can review the task or not.
        decline:
          type: boolean
          description: Member can decline the task or not.
        confirm:
          type: boolean
          description: Member can confirm the task or not.
        update:
          type: boolean
          description: Member can update the draft task or not.
        forward:
          type: boolean
          description: Member can forward the task or not.
        forward_request:
          type: boolean
          description: Member can send forward request to the owner or not.
        preview_attachments:
          type: boolean
          description: Member can preview the attachments or not.
        download:
          type: boolean
          description: Member can download the task or not.
        download_audit_trail:
          type: boolean
          description: Member can download the audit trail or not.
        download_attachments:
          type: boolean
          description: Member can download the attachments or not.
        download_source_files:
          type: boolean
          description: Member can download the source files or not.
        void:
          type: boolean
          description: Member can void the task or not.
        delete:
          type: boolean
          description: Member can delete the task or not.
        restore:
          type: boolean
          description: Member can restore the task or not.
        share_sign_link:
          type: boolean
          description: Member can share the sign link or not.
        archive:
          type: boolean
          description: Member can archive the task or not.
        dearchive:
          type: boolean
          description: Member can dearchive the task or not.
        save_template:
          type: boolean
          description: Member can save as a template or not.
        resend:
          type: boolean
          description: Member can resend the task or not.
        edit:
          type: boolean
          description: Member can edit the waiting task or not.
    SignTaskOwner:
      type: object
      description: Sign task owner.
      properties:
        name:
          type: string
          description: Owner's name.
        sequence:
          type: integer
          description: Owner's sequence, which is `0`.
        email:
          type: string
          description: Owner's email.
        status:
          type: string
          description: Owner's status.
          enum:
          - created
          - sent
          - voided
    SourceSettingCcInfo:
      type: object
      description: Source setting cc info.
      properties:
        email:
          type: string
          description: CC Email.
        name:
          type: string
          description: CC Name.
    SignTaskSetting:
      type: object
      properties:
        ai_summary:
          type: boolean
          description: Whether AI-generated summary and key information is enabled for the task.
        deadline:
          type: integer
          nullable: true
          description: Deadline in timestamp in seconds. *Used for `SignTask` only.*
        forget_remind:
          type: boolean
          description: Remind the signer or not when task is waiting for signing.
        expire_remind:
          type: boolean
          nullable: true
          description: Remind the signer or not when task is going to be expired. *Used for `SignTask` only.*
        remind_days_before_expire:
          type: integer
          nullable: true
          description: Days before expire to remind the signer. *Used for `SignTask` only.*
        link_expire_days:
          type: integer
          description: Days before the signing link expires. *Always resolved (request > template > owner preference), never null.*
        forget_remind_days:
          type: integer
          description: Days after the signing request to send the first reminder; a second reminder is sent at 3× this value. Only effective when `forget_remind` is `true`. *Always resolved (request > template > owner preference), never null.*
        expires_in_days:
          type: integer
          nullable: true
          description: Days before expire. *Used for `SignTask` only.*
        cc_infos:
          type: array
          items:
            $ref: '#/components/schemas/SourceSettingCcInfo'
        message:
          type: string
          nullable: true
          description: Message to the signer when task is processing.
        completed_message:
          type: string
          nullable: true
          description: Message to the signer when task is completed.
        reference_settings:
          type: array
          description: Reference information viewable to signers when task is processing.
          items:
            $ref: '#/components/schemas/SourceSettingReferenceSetting'
        completed_reference_settings:
          type: array
          description: Reference information viewable to signers when task is completed.
          deprecated: true
          items:
            $ref: '#/components/schemas/SourceSettingReferenceSetting'
        receiver_lang:
          type: string
          description: Language displayed for the signer, only effective if signer has not set his preferred language.
        owner_informable:
          type: boolean
          description: Inform the owner through email or not when task is updated.
          default: false
      description: Sign task setting.
    SignStage:
      type: object
      properties:
        stage_id:
          type: integer
          description: Stage ID.
        name:
          type: string
          description: Signer's name.
        email:
          type: string
          description: Actor's email.
        stage_type:
          type: string
          description: Stage type.
          enum:
          - sign
          - edit
          - form_sign
        sequence:
          type: integer
          description: Stage sequence, which starts from `1`.
        status:
          type: string
          description: Stage status.
          enum:
          - initial
          - processing
          - signed
          - done
          - modifying
          - reviewed
          - declined
          - canceled
      description: Sign stage.
    SignTask:
      type: object
      description: Sign task.
      properties:
        task_id:
          type: integer
          description: Task ID.
        file_name:
          type: string
          description: File name.
        sign_type:
          type: string
          description: Sign type.
          enum:
          - sign_and_send
          - create_and_invite
          - kiosk
          - guest_signing
          - form
        has_order:
          type: boolean
          description: Signers should sign sequentially or not.
        status:
          type: string
          description: Task status.
          enum:
          - draft
          - waiting
          - completed
          - declined
          - expired
          - voided
          - deleted
        last_modified_by_owner:
          type: boolean
          description: Last modification by owner or not.
        owned_by_me:
          type: boolean
          description: Task is owned by me or not.
        access_info:
          $ref: '#/components/schemas/SignTaskAccessInfo'
        current_stage_infos:
          type: array
          description: Current stages' info.
          items:
            type: object
            properties:
              stage_id:
                type: integer
                description: Stage ID.
              email:
                type: string
                description: Signer's email.
              name:
                type: string
                description: Signer's name.
        details:
          type: array
          description: 'Stage details, including owner''s and stages'' information.

            * For all tasks, first schema is `SignTaskOwner`.

            * For type of `sign_and_send`, `guest_signing` or `kiosk` tasks, see `DummyStage` schema.

            * For type of `create_and_invite` or `form` tasks, see `SignStage` schema.

            '
          items:
            anyOf:
            - $ref: '#/components/schemas/SignTaskOwner'
            - $ref: '#/components/schemas/DummyStage'
            - $ref: '#/components/schemas/SignStage'
        task_setting:
          $ref: '#/components/schemas/SignTaskSetting'
        metadata:
          type: object
          description: Metadata. **Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.**
        created_at:
          type: integer
          description: Task creation timestamp.
        last_modified_at:
          type: integer
          description: Task last modification timestamp.
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/createseal.md
  - https://developer.dottedsign.com/reference/getgroup.md
  - https://developer.dottedsign.com/reference/getgroupsigntaskslist.md
  - https://developer.dottedsign.com/reference/getseallist.md
  - https://developer.dottedsign.com/reference/updategroup.md
  merge:
    pages: 5
    deduped: 6
    conflicts_kept_first: 0