DocuSign REST API — Folders

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — Folders
  description: 'DocuSign REST API — Folders. 4 operations. Lead operation: Docusign Gets a list of the folders for the account..
    Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - Folders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-folders
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — Folders business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-folders
      path: /v2/accounts/{accountId}/folders
      operations:
      - name: foldersgetfolders
        method: GET
        description: Docusign Gets a list of the folders for the account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: include
          in: query
          type: string
          description: Reserved for DocuSign.
        - name: start_position
          in: query
          type: string
          description: Reserved for DocuSign.
        - name: template
          in: query
          type: string
          description: 'Specifies the items that are returned. Valid values are: '
        - name: user_filter
          in: query
          type: string
          description: Reserved for DocuSign.
    - name: v2-accounts-accountId-folders-folderId
      path: /v2/accounts/{accountId}/folders/{folderId}
      operations:
      - name: foldersgetfolderitems
        method: GET
        description: Docusign Gets a list of the envelopes in the specified folder.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: folderId
          in: path
          type: string
          description: The ID of the folder being accessed.
          required: true
        - name: from_date
          in: query
          type: string
          description: Only return items on or after this date. If no value is provided, the default search is the previous
            30 days.
        - name: owner_email
          in: query
          type: string
          description: The email of the folder owner.
        - name: owner_name
          in: query
          type: string
          description: The name of the folder owner.
        - name: search_text
          in: query
          type: string
          description: The search text used to search the items of the envelope. The search looks at recipient names and emails,
            envelope custom fields, sender name, and subject.
        - name: start_position
          in: query
          type: string
          description: 'The position of the folder items to return. This is used for repeated calls, when the number of envelopes
            returned is too much for one return (calls return 100 '
        - name: status
          in: query
          type: string
          description: 'A comma-separated list of current envelope statuses to included in the response. Possible values are:'
        - name: to_date
          in: query
          type: string
          description: Only return items up to this date. If no value is provided, the default search is to the current date.
      - name: foldersputfolderbyid
        method: PUT
        description: Docusign Moves an envelope from its current folder to the specified folder.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: folderId
          in: path
          type: string
          description: The ID of the folder being accessed.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-accounts-accountId-search_folders-searchFolderId
      path: /v2/accounts/{accountId}/search_folders/{searchFolderId}
      operations:
      - name: searchfoldersgetsearchfoldercontents
        method: GET
        description: Docusign Gets a list of envelopes in folders matching the specified criteria.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: searchFolderId
          in: path
          type: string
          description: 'Specifies the envelope group that is searched by the request. These are logical groupings, not actual
            folder names. Valid values are: drafts, awaiting_my_signat'
          required: true
        - name: all
          in: query
          type: string
          description: Specifies that all envelopes that match the criteria are returned.
        - name: count
          in: query
          type: string
          description: Specifies the number of records returned in the cache. The number must be greater than 0 and less than
            or equal to 100.
        - name: from_date
          in: query
          type: string
          description: Specifies the start of the date range to return. If no value is provided, the default search is the
            previous 30 days.
        - name: include_recipients
          in: query
          type: string
          description: When set to **true**, the recipient information is returned in the response.
        - name: order
          in: query
          type: string
          description: 'Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and
            `desc` for descending order.'
        - name: order_by
          in: query
          type: string
          description: 'Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`,
            `sent`, `signer_list`, `status`, or `subject`.'
        - name: start_position
          in: query
          type: string
          description: Specifies the the starting location in the result set of the items that are returned.
        - name: to_date
          in: query
          type: string
          description: Specifies the end of the date range to return.
  exposes:
  - type: rest
    namespace: docusign-folders-rest
    port: 8080
    description: REST adapter for DocuSign REST API — Folders. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/folders
      name: v2-accounts-accountid-folders
      description: REST surface for v2-accounts-accountId-folders.
      operations:
      - method: GET
        name: foldersgetfolders
        description: Docusign Gets a list of the folders for the account.
        call: docusign-folders.foldersgetfolders
        with:
          accountId: rest.accountId
          include: rest.include
          start_position: rest.start_position
          template: rest.template
          user_filter: rest.user_filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/accounts/{accountid}/folders/{folderid}
      name: v2-accounts-accountid-folders-folderid
      description: REST surface for v2-accounts-accountId-folders-folderId.
      operations:
      - method: GET
        name: foldersgetfolderitems
        description: Docusign Gets a list of the envelopes in the specified folder.
        call: docusign-folders.foldersgetfolderitems
        with:
          accountId: rest.accountId
          folderId: rest.folderId
          from_date: rest.from_date
          owner_email: rest.owner_email
          owner_name: rest.owner_name
          search_text: rest.search_text
          start_position: rest.start_position
          status: rest.status
          to_date: rest.to_date
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: foldersputfolderbyid
        description: Docusign Moves an envelope from its current folder to the specified folder.
        call: docusign-folders.foldersputfolderbyid
        with:
          accountId: rest.accountId
          folderId: rest.folderId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/accounts/{accountid}/search-folders/{searchfolderid}
      name: v2-accounts-accountid-search-folders-searchfolderid
      description: REST surface for v2-accounts-accountId-search_folders-searchFolderId.
      operations:
      - method: GET
        name: searchfoldersgetsearchfoldercontents
        description: Docusign Gets a list of envelopes in folders matching the specified criteria.
        call: docusign-folders.searchfoldersgetsearchfoldercontents
        with:
          accountId: rest.accountId
          searchFolderId: rest.searchFolderId
          all: rest.all
          count: rest.count
          from_date: rest.from_date
          include_recipients: rest.include_recipients
          order: rest.order
          order_by: rest.order_by
          start_position: rest.start_position
          to_date: rest.to_date
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-folders-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — Folders. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: docusign-gets-list-folders-account
      description: Docusign Gets a list of the folders for the account.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-folders.foldersgetfolders
      with:
        accountId: tools.accountId
        include: tools.include
        start_position: tools.start_position
        template: tools.template
        user_filter: tools.user_filter
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-gets-list-envelopes-specified
      description: Docusign Gets a list of the envelopes in the specified folder.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-folders.foldersgetfolderitems
      with:
        accountId: tools.accountId
        folderId: tools.folderId
        from_date: tools.from_date
        owner_email: tools.owner_email
        owner_name: tools.owner_name
        search_text: tools.search_text
        start_position: tools.start_position
        status: tools.status
        to_date: tools.to_date
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-moves-envelope-its-current
      description: Docusign Moves an envelope from its current folder to the specified folder.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-folders.foldersputfolderbyid
      with:
        accountId: tools.accountId
        folderId: tools.folderId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-gets-list-envelopes-folders
      description: Docusign Gets a list of envelopes in folders matching the specified criteria.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-folders.searchfoldersgetsearchfoldercontents
      with:
        accountId: tools.accountId
        searchFolderId: tools.searchFolderId
        all: tools.all
        count: tools.count
        from_date: tools.from_date
        include_recipients: tools.include_recipients
        order: tools.order
        order_by: tools.order_by
        start_position: tools.start_position
        to_date: tools.to_date
      outputParameters:
      - type: object
        mapping: $.