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.
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"]["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 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_envelope_transfer_rules_get_envelope_transfer_rules(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 | |
query | object | Optional | Additional keys: not allowed |
query.count | string | Optional | |
query.start_position | 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 Gets envelope transfer rules — response body |
Referenced models: Gets envelope transfer rules — response body
Schemas
Section titled “Schemas”119 more schemas are linked from the tables above, on the schema pages.
Gets envelope transfer rules — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
envelopeTransferRules | array | Optional | Contains information about a specific envelope transfer rule. |
envelopeTransferRules[] | Model | Each item | Expand Gets envelope transfer rules — response body — envelope Transfer Rules 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: Gets envelope transfer rules — response body — envelope Transfer Rules item
Gets envelope transfer rules — response body — envelope Transfer Rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about an envelope transfer rule. |
carbonCopyOriginalOwner | string | Optional | When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.** |
enabled | string | Optional | When **true,** the envelope transfer rule is active. |
envelopeTransferRuleId | string | Optional | The ID of the envelope transfer rule. The system generates this ID when the rule is first created. |
eventType | string | Optional | The type of envelope event that triggers the transfer. Valid values are: - `sent` - `before sent` - `completed` |
fromGroup | Model | Optional | Expand Deletes an existing user group — response body — groups item Information about the group that triggers the transfer. |
fromUser | Model | Optional | Expand 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. |
modifiedDate | string | Optional | The UTC DateTime when the envelope transfer rule was last modified. This property is read-only. |
modifiedUser | Model | Optional | Expand 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. |
toFolder | Model | Optional | Expand Gets the list of templates — response body — folders item Information about the destination folder to which the envelope is transferred. |
toUser | Model | Optional | Expand 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
| 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
Deletes an existing user group — response body — groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a group. |
accessType | string | Optional | |
dsGroupId | string | Optional | Reserved for Docusign. |
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. |
groupId | string | Optional | The Docusign group ID for the group. This is a read-only property. |
groupName | string | Optional | The name of the group. |
groupType | string | Optional | The group type. |
isManagedByScim | boolean | Optional | |
lastModifiedOn | string | Optional | |
permissionProfileId | string | Optional | The 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. |
userGroupType | string | Optional | |
users | array | Optional | A 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[] | Model | Each item | Expand Gets a specific template associated with a specified account — response body — owner |
usersCount | string | Optional | The 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
| 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. |
Get credit card information — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains address information. |
address1 | string | Optional | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the user's address. Maximum length: 100 characters. |
city | string | Optional | The user's city. Maximum length: 40 characters. |
country | string | Optional | The user's country. Maximum length: 50 characters. |
fax | string | Optional | A fax number associated with the address, if one is available. |
phone | string | Optional | A phone number associated with the address. |
postalCode | string | Optional | The user's postal code. Maximum length: 20 characters. |
stateOrProvince | string | Optional | The user's state or province. Maximum length: 40 characters. |
zipPlus4 | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.