Skip to content

DocuSign: Get Connect configuration information

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

← Esignature operations · Get started

Operation docusign.esignature_connect_getconnectconfigs

Provider route: GET /restapi/v2.1/accounts/{accountId}/connect. 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"]["esignatureConnectGetConnectConfigs"]>[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.esignatureConnectGetConnectConfigs(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_connect_get_connect_configs(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Connect configuration information — response body

Referenced models: Get Connect configuration information — response body

1 more schema is linked from the tables above, on the schema pages.

Get Connect configuration information — response body
FieldTypePresenceDescription and constraints
$objectRootThis object contains the results of a ConnectConfigurations::GET method.
configurationsarrayOptionalAn array of Docusign Connect configurations.
configurations[]ModelEach itemExpand Creates a Connect configuration — response body
totalRecordsstringOptionalThe number of results.

Referenced models: Creates a Connect configuration — response body

Creates a Connect configuration — response body — event Data
FieldTypePresenceDescription and constraints
$objectRootThis object lets you choose the data format of your Connect response.
formatstringOptionalReserved for Docusign.
includeDataarrayOptionalA string array of the data to be included.
The default is the empty array `[]`.

- `attachments`: Include attachments associated with the envelope.
- `custom_fields`: Include the custom fields associated with the envelope.
- `documents`: Include the documents associated with the envelope.
- `extensions`: Include information about the email settings associated with the envelope.
- `folders`: Include the folder where the envelope exists.
- `payment_tabs`: Include the payment tabs associated with the envelope.
- `powerform`: Include the PowerForms associated with the envelope.
- `prefill_tabs`: Include the [pre-filled tabs](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope.
- `recipients`: Include the recipients associated with the envelope.
- `tabs`: Include the tabs associated with the envelope.
includeData[]stringEach item
versionstringOptionalSet this property to `restv2.1` to return event data in JSON. If the property is not set, the event data will be returned in XML by default.
Set up Connect O Auth for the specified account — response body
FieldTypePresenceDescription and constraints
$objectRootA complex object describing a Connect OAuth configuration.
authorizationServerUrlstringOptionalThe token URL for your authorization server or OAuth service.

This property is required.
clientIdstringOptionalThe client ID assigned to your app by your authorization server or OAuth service.

This property is required.
clientSecretstringOptionalThe secret value provided by your authorization server.

This property is required.
customParametersobjectOptionalAdditional keys: see wildcard field
customParameters.*stringAdditional keys
scopestringOptionalThe scopes that your app will request from the authorization server.

This property is optional.

**Note:** If you are using Azure, this value is the application ID URI of the secified resource affixed with the `.default`. For example: `api://{{clientId}}/.default`
Creates a Connect configuration — response body — sf Objects item
FieldTypePresenceDescription and constraints
$objectRootA `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.

When you install Docusign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize Docusign Connect for Salesforce by associating Docusign objects with Salesforce objects so that Docusign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see
[Docusign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).
activestringOptionalWhen **true,** the `connectSalesforceObject` is active.
descriptionstringOptionalA description of the `connectSalesforceObject`.
idstringOptionalThe ID of the `connectSalesforceObject`.
insertstringOptional
onCompleteOnlystringOptionalWhen **true,** Salesforce is updated only when the envelope is complete.
selectFieldsarrayOptionalThe Docusign and Salesforce fields that you want to use to match a Salesforce object with Docusign information. This information tells Connect when to send updates to Salesforce.
selectFields[]ModelEach itemExpand Creates a Connect configuration — response body — sf Objects item select Fields item
sfObjectstringOptionalThe Salesforce.com object type, such as `case`, `contact`, or `opportunity`.
sfObjectNamestringOptionalA name for the Salesforce object.

**Note:** You can enter any name for the object. It does not have to match the `sfObject` property.
updateFieldsarrayOptionalThe Docusign and Salesforce fields that you want to update.

**Note:** You can choose to update SalesForce (with information from Docusign) only, update Docusign only, or both.
updateFields[]ModelEach itemExpand Creates a Connect configuration — response body — sf Objects item select Fields item

Referenced models: Creates a Connect configuration — response body — sf Objects item select Fields item

Creates a Connect configuration — response body — sf Objects item select Fields item
FieldTypePresenceDescription and constraints
$objectRootThis object is used to match a Docusign field to a Salesforce field so that Docusign can send information to your Salesforce account.
dsAttributestringOptional
dsLinkstringOptionalA URL that links to the information in the Docusign field.
dsNodestringOptional
idstringOptionalA unique ID for the Salesforce object.
sfFieldstringOptional
sfFieldNamestringOptionalThe name of the Salesforce field.
sfFolderstringOptionalThe name of the Salesforce folder.
sfLockedValuestringOptional

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