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.
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"]["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 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_search_folders_get_search_folder_contents(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.searchFolderId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.all | string | Optional | |
query.count | string | Optional | |
query.from_date | string | Optional | |
query.include_recipients | string | Optional | |
query.order | string | Optional | |
query.order_by | string | Optional | |
query.start_position | 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 Deprecated. Use Envelopes: list Status Changes — response body |
Referenced models: Deprecated. Use Envelopes: list Status Changes — response body
Schemas
Section titled “Schemas”106 more schemas are linked from the tables above, on the schema pages.
Deprecated. Use Envelopes: list Status Changes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Results from a folder item request. |
endPosition | string | Optional | The last index position in the result set. |
folderItems | array | Optional | A list of the envelopes in the specified folder or folders. |
folderItems[] | Model | Each item | Expand Deprecated. Use Envelopes: list Status Changes — response body — folder Items 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. |
totalRows | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about folder item results. |
completedDateTime | string | Optional | If the item is an envelope, this is the UTC DateTime when the envelope was completed. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
envelopeId | string | Optional | If the item is an envelope, this is the ID of the envelope. |
envelopeUri | string | Optional | If the item is an envelope, this is the URI for retrieving it. |
expireDateTime | string | Optional | The date and time the envelope is set to expire. |
folderId | string | Optional | The ID of the folder. |
folderUri | string | Optional | If the item is a subfolder, this is the URI for retrieving it. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
ownerName | string | Optional | The name of the user who owns the folder. |
recipients | Model | Optional | Expand Deletes recipients from an envelope — response body An array of recipient objects that provides details about the recipients of the envelope. |
recipientsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the recipients. |
senderCompany | string | Optional | The name of the sender's company. |
senderEmail | string | Optional | The sender's email address. |
senderName | string | Optional | The sender's name. |
senderUserId | string | Optional | The sender's id. |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
status | string | Optional | Indicates 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. |
subject | string | Optional | The subject of the envelope. |
templateId | string | Optional | The unique identifier of the template. If this is not provided, Docusign will generate a value. |
templateUri | string | Optional | The URI for retrieving the template. |
Referenced models: Deletes recipients from an envelope — response body
Deletes recipients from an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Envelope recipients |
agents | array | Optional | A list of agent recipients assigned to the documents. |
agents[] | Model | Each item | Expand Deletes recipients from a template — response body — agents item |
authorizedSignatories | array | Optional | |
authorizedSignatories[] | Model | Each item | Expand Deletes recipients from a template — response body — authorized Signatories item |
carbonCopies | array | Optional | A list of carbon copy recipients assigned to the documents. |
carbonCopies[] | Model | Each item | Expand Deletes recipients from a template — response body — carbon Copies item |
certifiedDeliveries | array | Optional | A 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[] | Model | Each item | Expand Deletes recipients from a template — response body — certified Deliveries item |
currentRoutingOrder | string | Optional | The 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. |
editors | array | Optional | A list of users who can edit the envelope. |
editors[] | Model | Each item | Expand Deletes recipients from a template — response body — editors item |
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. |
inPersonSigners | array | Optional | Specifies 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[] | Model | Each item | Expand Deletes recipients from a template — response body — in Person Signers item |
intermediaries | array | Optional | Identifies 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[] | Model | Each item | Expand Deletes recipients from a template — response body — intermediaries item |
notaries | array | Optional | A list of notary recipients on the envelope. |
notaries[] | Model | Each item | Expand Deletes recipients from a template — response body — notaries item |
notaryWitnesses | array | Optional | |
notaryWitnesses[] | Model | Each item | Expand Deletes recipients from a template — response body — notary Witnesses item |
participants | array | Optional | |
participants[] | Model | Each item | Expand Deletes recipients from a template — response body — participants item |
recipientCount | string | Optional | The number of recipients in the envelope. |
seals | array | Optional | A list of electronic seals to apply to documents. |
seals[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item |
signers | array | Optional | A list of signers on the envelope. |
signers[] | Model | Each item | Expand Deletes recipients from a template — response body — signers item |
witnesses | array | Optional | A list of signers who act as witnesses on the envelope. |
witnesses[] | Model | Each item | Expand 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
| 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.