DocuSign: Gets the details about a Connect configuration
DocuSign esignature.esignatureConnectGetConnectConfig: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_connect_getconnectconfig
Provider route: GET /restapi/v2.1/accounts/{accountId}/connect/{connectId}. 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"]["esignatureConnectGetConnectConfig"]>[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.esignatureConnectGetConnectConfig(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_connect_get_connect_config(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.connectId | string | Required within parent |
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 Get Connect configuration information — response body |
Referenced models: Get Connect configuration information — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Get Connect configuration information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains the results of a ConnectConfigurations::GET method. |
configurations | array | Optional | An array of Docusign Connect configurations. |
configurations[] | Model | Each item | Expand Creates a Connect configuration — response body |
totalRecords | string | Optional | The number of results. |
Referenced models: Creates a Connect configuration — response body
Creates a Connect configuration — response body — event Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object lets you choose the data format of your Connect response. |
format | string | Optional | Reserved for Docusign. |
includeData | array | Optional | A 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[] | string | Each item | |
version | string | Optional | Set 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object describing a Connect OAuth configuration. |
authorizationServerUrl | string | Optional | The token URL for your authorization server or OAuth service. This property is required. |
clientId | string | Optional | The client ID assigned to your app by your authorization server or OAuth service. This property is required. |
clientSecret | string | Optional | The secret value provided by your authorization server. This property is required. |
customParameters | object | Optional | Additional keys: see wildcard field |
customParameters.* | string | Additional keys | |
scope | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A `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). |
active | string | Optional | When **true,** the `connectSalesforceObject` is active. |
description | string | Optional | A description of the `connectSalesforceObject`. |
id | string | Optional | The ID of the `connectSalesforceObject`. |
insert | string | Optional | |
onCompleteOnly | string | Optional | When **true,** Salesforce is updated only when the envelope is complete. |
selectFields | array | Optional | The 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[] | Model | Each item | Expand Creates a Connect configuration — response body — sf Objects item select Fields item |
sfObject | string | Optional | The Salesforce.com object type, such as `case`, `contact`, or `opportunity`. |
sfObjectName | string | Optional | A name for the Salesforce object. **Note:** You can enter any name for the object. It does not have to match the `sfObject` property. |
updateFields | array | Optional | The 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[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is used to match a Docusign field to a Salesforce field so that Docusign can send information to your Salesforce account. |
dsAttribute | string | Optional | |
dsLink | string | Optional | A URL that links to the information in the Docusign field. |
dsNode | string | Optional | |
id | string | Optional | A unique ID for the Salesforce object. |
sfField | string | Optional | |
sfFieldName | string | Optional | The name of the Salesforce field. |
sfFolder | string | Optional | The name of the Salesforce folder. |
sfLockedValue | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_connect_getconnectconfig. Catalog operation: esignature:Connect_GetConnectConfig. 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.