Skip to content

DocuSign: Gets envelope transfer rules

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

← Esignature operations · Get started

Operation docusign.esignature_envelopetransferrules_getenvelopetransferrules

Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/transfer_rules. 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"]["esignatureEnvelopeTransferRulesGetEnvelopeTransferRules"]>[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.esignatureEnvelopeTransferRulesGetEnvelopeTransferRules(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_envelope_transfer_rules_get_envelope_transfer_rules(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
queryobjectOptionalAdditional keys: not allowed
query.countstringOptional
query.start_positionstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets envelope transfer rules — response body

Referenced models: Gets envelope transfer rules — response body

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

Gets envelope transfer rules — response body
FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
envelopeTransferRulesarrayOptionalContains information about a specific envelope transfer rule.
envelopeTransferRules[]ModelEach itemExpand Gets envelope transfer rules — response body — envelope Transfer Rules 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: Gets envelope transfer rules — response body — envelope Transfer Rules item

Gets envelope transfer rules — response body — envelope Transfer Rules item
FieldTypePresenceDescription and constraints
$objectRootThis object contains details about an envelope transfer rule.
carbonCopyOriginalOwnerstringOptionalWhen **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**
enabledstringOptionalWhen **true,** the envelope transfer rule is active.
envelopeTransferRuleIdstringOptionalThe ID of the envelope transfer rule. The system generates this ID when the rule is first created.
eventTypestringOptionalThe type of envelope event that triggers the transfer. Valid values are:

- `sent`
- `before sent`
- `completed`
fromGroupModelOptionalExpand Deletes an existing user group — response body — groups item
Information about the group that triggers the transfer.
fromUserModelOptionalExpand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Information about the user who triggers the transfer.
modifiedDatestringOptionalThe UTC DateTime when the envelope transfer rule was last modified. This property is read-only.
modifiedUserModelOptionalExpand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Information about the user who last modified the envelope transfer rule.
toFolderModelOptionalExpand Gets the list of templates — response body — folders item
Information about the destination folder to which the envelope is transferred.
toUserModelOptionalExpand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Information about the user to which the envelope is transferred.

Referenced models: Gets the list of templates — response body — folders item, Deletes an existing user group — response body — groups item, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body

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

Deletes an existing user group — response body — groups item
FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a group.
accessTypestringOptional
dsGroupIdstringOptionalReserved for Docusign.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
groupIdstringOptionalThe Docusign group ID for the group.
This is a read-only property.
groupNamestringOptionalThe name of the group.
groupTypestringOptionalThe group type.
isManagedByScimbooleanOptional
lastModifiedOnstringOptional
permissionProfileIdstringOptionalThe ID of the permission profile associated with the group.

Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)
to get a list of permission profiles and their IDs.
userGroupTypestringOptional
usersarrayOptionalA list of the users in the group. This property is not used by [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/)
users[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner
usersCountstringOptionalThe total number of users in the group.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

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.
Get credit card information — response body — address
FieldTypePresenceDescription and constraints
$objectRootContains address information.
address1stringOptionalThe first line of the user's address.
Maximum length: 100 characters.
address2stringOptionalThe second line of the user's address.
Maximum length: 100 characters.
citystringOptionalThe user's city. Maximum length: 40 characters.
countrystringOptionalThe user's country. Maximum length: 50 characters.
faxstringOptionalA fax number associated with the address, if one is available.
phonestringOptionalA phone number associated with the address.
postalCodestringOptionalThe user's postal code. Maximum length: 20 characters.
stateOrProvincestringOptionalThe user's state or province. Maximum length: 40 characters.
zipPlus4stringOptional

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