Skip to content

DocuSign: Gets information about items in a specified folder

DocuSign esignature.esignatureFoldersGetFolderItems: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_folders_getfolderitems

Provider route: GET /restapi/v2.1/accounts/{accountId}/folders/{folderId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureFoldersGetFolderItems"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureFoldersGetFolderItems(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_folders_get_folder_items(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.folderIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.from_datestringOptional
query.include_itemsstringOptional
query.owner_emailstringOptional
query.owner_namestringOptional
query.search_textstringOptional
query.start_positionstringOptional
query.statusstringOptional
query.to_datestringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns a list of the account’s folders — response body

Referenced models: Returns a list of the account’s folders — response body

108 more schemas are linked from the tables above, on the schema pages.

Returns a list of the account's folders — response body
FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
envelopesarrayOptional
envelopes[]ModelEach itemExpand Creates an envelope — response body
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Creates an envelope — response body, Gets the list of templates — response body — folders item

Creates an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootThis object describes an envelope.
bulkEnvelopeStatusModelOptionalExpand Creates an envelope — response body — bulk Envelope Status
An object that describes the status of the bulk send envelopes.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientSigningUristringOptional
recipientSigningUriErrorstringOptional
statusstringOptionalIndicates the envelope status. Valid values are:

* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
* `created`: The envelope is created as a draft. It can be modified and sent later.
* `declined`: The envelope has been declined by the recipients.
* `delivered`: The envelope has been delivered to the recipients.
* `sent`: The envelope will be sent to the recipients after the envelope is created.
* `signed`: The envelope has been signed by the recipients.
* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.
statusDateTimestringOptionalThe DateTime that the envelope changed status (i.e. was created or sent.)
uristringOptionalA URI containing the user ID.

Referenced models: Creates an envelope — response body — bulk Envelope Status, Locks a template — response body — error Details

Gets the list of templates — response body — folders item
FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a folder.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
filterModelOptionalExpand Gets the list of templates — response body — folders item filter
An object used to present a filtered view of the items in a folder.
folderIdstringOptionalThe ID of the folder.
folderItemsarrayOptionalA list of envelopes and templates that the folder contains.
folderItems[]ModelEach itemExpand Deprecated. Use Envelopes: list Status Changes — response body — folder Items item
foldersarrayOptionalA collection of folder objects returned in a response.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
hasAccessstringOptionalWhen **true,** the current user has access to the folder.
hasSubFoldersstringOptionalWhen **true,** the folder has subfolders.
itemCountstringOptionalThe number of items in the folder.
namestringOptionalThe name of the folder.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the folder.
parentFolderIdstringOptionalThe ID of the parent folder, or the special value `root` for the root folder.
parentFolderUristringOptionalThe URI of the parent folder.
subFolderCountstringOptionalThe number of subfolders.
typestringOptionalThe type of folder. Possible values include:

- `draft`
- `inbox`
- `normal` (a system-generated folder)
- `recyclebin`
- `sentitems`
- `custom` (a custom folder created by a user)
uristringOptionalThe URI for the folder.

Referenced models: Locks a template — response body — error Details, Gets the list of templates — response body — folders item filter, Gets the list of templates — response body — folders item, Deprecated. Use Envelopes: list Status Changes — response body — folder Items item, Gets a specific template associated with a specified account — response body — owner

Creates an envelope — response body — bulk Envelope Status
FieldTypePresenceDescription and constraints
$objectRoot
batchIdstringOptionalSpecifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
batchSizestringOptionalThe number of items returned in this response.
bulkEnvelopesarrayOptionalA list of bulk envelope objects.
bulkEnvelopes[]ModelEach itemExpand Creates an envelope — response body — bulk Envelope Status bulk Envelopes item
bulkEnvelopesBatchUristringOptionalURI at which you can retrieve the batch envelopes.
endPositionstringOptionalThe last index position in the result set.
failedstringOptionalThe number of entries with a status of failed.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
queuedstringOptionalThe number of entries with a status of queued.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
sentstringOptionalThe number of entries with a status of sent.
startPositionstringOptionalThe starting index position of the current result set.
submittedDatestringOptionalThe date on which the bulk envelope was created.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Creates an envelope — response body — bulk Envelope Status bulk Envelopes item

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Deletes recipients from a template — response body — agents item consent Details List item
FieldTypePresenceDescription and constraints
$objectRoot
consentKeystringOptional
deliveryMethodstringOptionalThe delivery method. One of:

- `email`
- `fax`
- `SMS`
- `WhatsApp`
- `offline`

The `SMS` and `WhatsApp` delivery methods
are limited to `signer`, `carbonCopy`, and `certifiedDelivery`
recipients.

**Related topics**

- [Using SMS delivery with the eSignature API][smsconcept]
- [How to request a signature by SMS or WhatsApp delivery][howto]

[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/
[howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/
signerConsentStatusstringOptional
Deletes recipients from a template — response body — seals item recipient Feature Metadata item
FieldTypePresenceDescription and constraints
$objectRoot
availabiltystringOptional
featureNamestringOptional

SDK function policy ID: docusign.esignature_folders_getfolderitems. Catalog operation: esignature:Folders_GetFolderItems. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.