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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.folderId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.from_date | string | Optional | |
query.include_items | string | Optional | |
query.owner_email | string | Optional | |
query.owner_name | string | Optional | |
query.search_text | string | Optional | |
query.start_position | string | Optional | |
query.status | string | Optional | |
query.to_date | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Returns a list of the account’s folders — response body |
Referenced models: Returns a list of the account’s folders — response body
Schemas
Section titled “Schemas”108 more schemas are linked from the tables above, on the schema pages.
Returns a list of the account's folders — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
envelopes | array | Optional | |
envelopes[] | Model | Each item | Expand Creates an envelope — response body |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
nextUri | string | Optional | The 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. |
previousUri | string | Optional | The 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. |
resultSetSize | string | Optional | The 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`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes an envelope. |
bulkEnvelopeStatus | Model | Optional | Expand Creates an envelope — response body — bulk Envelope Status An object that describes the status of the bulk send envelopes. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
recipientSigningUri | string | Optional | |
recipientSigningUriError | string | Optional | |
status | string | Optional | Indicates 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. |
statusDateTime | string | Optional | The DateTime that the envelope changed status (i.e. was created or sent.) |
uri | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a folder. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
filter | Model | Optional | Expand Gets the list of templates — response body — folders item filter An object used to present a filtered view of the items in a folder. |
folderId | string | Optional | The ID of the folder. |
folderItems | array | Optional | A list of envelopes and templates that the folder contains. |
folderItems[] | Model | Each item | Expand Deprecated. Use Envelopes: list Status Changes — response body — folder Items item |
folders | array | Optional | A collection of folder objects returned in a response. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
hasAccess | string | Optional | When **true,** the current user has access to the folder. |
hasSubFolders | string | Optional | When **true,** the folder has subfolders. |
itemCount | string | Optional | The number of items in the folder. |
name | string | Optional | The name of the folder. |
owner | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the folder. |
parentFolderId | string | Optional | The ID of the parent folder, or the special value `root` for the root folder. |
parentFolderUri | string | Optional | The URI of the parent folder. |
subFolderCount | string | Optional | The number of subfolders. |
type | string | Optional | The type of folder. Possible values include: - `draft` - `inbox` - `normal` (a system-generated folder) - `recyclebin` - `sentitems` - `custom` (a custom folder created by a user) |
uri | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
batchId | string | Optional | Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. |
batchSize | string | Optional | The number of items returned in this response. |
bulkEnvelopes | array | Optional | A list of bulk envelope objects. |
bulkEnvelopes[] | Model | Each item | Expand Creates an envelope — response body — bulk Envelope Status bulk Envelopes item |
bulkEnvelopesBatchUri | string | Optional | URI at which you can retrieve the batch envelopes. |
endPosition | string | Optional | The last index position in the result set. |
failed | string | Optional | The number of entries with a status of failed. |
nextUri | string | Optional | The 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. |
previousUri | string | Optional | The 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. |
queued | string | Optional | The number of entries with a status of queued. |
resultSetSize | string | Optional | The 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`. |
sent | string | Optional | The number of entries with a status of sent. |
startPosition | string | Optional | The starting index position of the current result set. |
submittedDate | string | Optional | The date on which the bulk envelope was created. |
totalSetSize | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Deletes recipients from a template — response body — agents item consent Details List item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
consentKey | string | Optional | |
deliveryMethod | string | Optional | The 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/ |
signerConsentStatus | string | Optional |
Deletes recipients from a template — response body — seals item recipient Feature Metadata item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
availabilty | string | Optional | |
featureName | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.