Skip to content

DocuSign: Deprecated Use Envelopes: list Status Changes

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

← Esignature operations · Get started

Operation docusign.esignature_searchfolders_getsearchfoldercontents

Provider route: GET /restapi/v2.1/accounts/{accountId}/search_folders/{searchFolderId}. 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"]["esignatureSearchFoldersGetSearchFolderContents"]>[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.esignatureSearchFoldersGetSearchFolderContents(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_search_folders_get_search_folder_contents(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.searchFolderIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.allstringOptional
query.countstringOptional
query.from_datestringOptional
query.include_recipientsstringOptional
query.orderstringOptional
query.order_bystringOptional
query.start_positionstringOptional
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 Deprecated. Use Envelopes: list Status Changes — response body

Referenced models: Deprecated. Use Envelopes: list Status Changes — response body

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

Deprecated. Use Envelopes: list Status Changes — response body
FieldTypePresenceDescription and constraints
$objectRootResults from a folder item request.
endPositionstringOptionalThe last index position in the result set.
folderItemsarrayOptionalA list of the envelopes in the specified folder or folders.
folderItems[]ModelEach itemExpand Deprecated. Use Envelopes: list Status Changes — response body — folder Items 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.
totalRowsstringOptionalThe total number of items in the result.

Referenced models: Deprecated. Use Envelopes: list Status Changes — response body — folder Items item

Deprecated. Use Envelopes: list Status Changes — response body — folder Items item
FieldTypePresenceDescription and constraints
$objectRootInformation about folder item results.
completedDateTimestringOptionalIf the item is an envelope, this is the UTC DateTime when the envelope was completed.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
envelopeIdstringOptionalIf the item is an envelope, this is the ID of the envelope.
envelopeUristringOptionalIf the item is an envelope, this is the URI for retrieving it.
expireDateTimestringOptionalThe date and time the envelope is set to expire.
folderIdstringOptionalThe ID of the folder.
folderUristringOptionalIf the item is a subfolder, this is the URI for retrieving it.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
ownerNamestringOptionalThe name of the user who owns the folder.
recipientsModelOptionalExpand Deletes recipients from an envelope — response body
An array of recipient objects that provides details about the recipients of the envelope.
recipientsUristringOptionalContains a URI for an endpoint that you can use to retrieve the recipients.
senderCompanystringOptionalThe name of the sender's company.
senderEmailstringOptionalThe sender's email address.
senderNamestringOptionalThe sender's name.
senderUserIdstringOptionalThe sender's id.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
statusstringOptionalIndicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later.
subjectstringOptionalThe subject of the envelope.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templateUristringOptionalThe URI for retrieving the template.

Referenced models: Deletes recipients from an envelope — response body

Deletes recipients from an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootEnvelope recipients
agentsarrayOptionalA list of agent recipients assigned to the documents.
agents[]ModelEach itemExpand Deletes recipients from a template — response body — agents item
authorizedSignatoriesarrayOptional
authorizedSignatories[]ModelEach itemExpand Deletes recipients from a template — response body — authorized Signatories item
carbonCopiesarrayOptionalA list of carbon copy recipients assigned to the documents.
carbonCopies[]ModelEach itemExpand Deletes recipients from a template — response body — carbon Copies item
certifiedDeliveriesarrayOptionalA complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
certifiedDeliveries[]ModelEach itemExpand Deletes recipients from a template — response body — certified Deliveries item
currentRoutingOrderstringOptionalThe routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
editorsarrayOptionalA list of users who can edit the envelope.
editors[]ModelEach itemExpand Deletes recipients from a template — response body — editors item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
inPersonSignersarrayOptionalSpecifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
inPersonSigners[]ModelEach itemExpand Deletes recipients from a template — response body — in Person Signers item
intermediariesarrayOptionalIdentifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
intermediaries[]ModelEach itemExpand Deletes recipients from a template — response body — intermediaries item
notariesarrayOptionalA list of notary recipients on the envelope.
notaries[]ModelEach itemExpand Deletes recipients from a template — response body — notaries item
notaryWitnessesarrayOptional
notaryWitnesses[]ModelEach itemExpand Deletes recipients from a template — response body — notary Witnesses item
participantsarrayOptional
participants[]ModelEach itemExpand Deletes recipients from a template — response body — participants item
recipientCountstringOptionalThe number of recipients in the envelope.
sealsarrayOptionalA list of electronic seals to apply to documents.
seals[]ModelEach itemExpand Deletes recipients from a template — response body — seals item
signersarrayOptionalA list of signers on the envelope.
signers[]ModelEach itemExpand Deletes recipients from a template — response body — signers item
witnessesarrayOptionalA list of signers who act as witnesses on the envelope.
witnesses[]ModelEach itemExpand Deletes recipients from a template — response body — witnesses item

Referenced models: Deletes recipients from a template — response body — agents item, Deletes recipients from a template — response body — authorized Signatories item, Deletes recipients from a template — response body — carbon Copies item, Deletes recipients from a template — response body — certified Deliveries item, Deletes recipients from a template — response body — editors item, Locks a template — response body — error Details, Deletes recipients from a template — response body — in Person Signers item, Deletes recipients from a template — response body — intermediaries item, Deletes recipients from a template — response body — notaries item, Deletes recipients from a template — response body — notary Witnesses item, Deletes recipients from a template — response body — participants item, Deletes recipients from a template — response body — seals item, Deletes recipients from a template — response body — signers item, Deletes recipients from a template — response body — witnesses 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.

SDK function policy ID: docusign.esignature_searchfolders_getsearchfoldercontents. Catalog operation: esignature:SearchFolders_GetSearchFolderContents. 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.