Get Connect configuration

GET

/v2.1/accounts/:accountId/connect/:connectId

GET

/restapi/v2.1/accounts/:accountId/connect/:connectId

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/connect/CONNECT_ID \
     -H "Authorization: Bearer <apiKey>"

{
  "configurations": [
    {
      "allowEnvelopePublish": "sample string 1",
      "allowSalesforcePublish": "sample string 2",
      "allUsers": "sample string 3",
      "allUsersExcept": "sample string 4",
      "configurationType": "sample string 5",
      "connectId": "sample string 6",
      "deliveryMode": "sample string 7",
      "disabledBy": "sample string 8",
      "enableLog": "sample string 9",
      "enableOAuthPerConfiguration": "sample string 10",
      "envelopeEvents": [
        "sample string 1"
      ],
      "eventData": {
        "format": "sample string 1",
        "includeData": [
          "sample string 1"
        ],
        "version": "sample string 2"
      },
      "events": [
        "sample string 1"
      ],
      "externalFolderId": "sample string 11",
      "externalFolderLabel": "sample string 12",
      "groupIds": [
        "sample string 1"
      ],
      "includeCertificateOfCompletion": "sample string 13",
      "includeCertSoapHeader": "sample string 14",
      "includeDocumentFields": "sample string 15",
      "includeDocuments": "sample string 16",
      "includeEnvelopeVoidReason": "sample string 17",
      "includeHMAC": "sample string 18",
      "includeOAuth": "sample string 19",
      "includeSenderAccountasCustomField": "sample string 20",
      "includeTimeZoneInformation": "sample string 21",
      "integratorManaged": "sample string 22",
      "name": "sample string 23",
      "oAuthConfiguration": {
        "authorizationServerUrl": "sample string 1",
        "clientId": "sample string 2",
        "clientSecret": "sample string 3",
        "customParameters": {
          "key": "sample string 1"
        },
        "scope": "sample string 4"
      },
      "password": "sample string 24",
      "pausePublish": "sample string 25",
      "recipientEvents": [
        "sample string 1"
      ],
      "requireMutualTls": "sample string 26",
      "requiresAcknowledgement": "sample string 27",
      "salesforceApiVersion": "sample string 28",
      "salesforceAuthcode": "sample string 29",
      "salesforceCallBackUrl": "sample string 30",
      "salesforceCodeVerifier": "sample string 31",
      "salesforceDocumentsAsContentFiles": "sample string 32",
      "senderOverride": "sample string 33",
      "senderSelectableItems": [
        "sample string 1"
      ],
      "sfObjects": [
        {
          "active": "sample string 1",
          "description": "sample string 2",
          "id": "sample string 3",
          "insert": "sample string 4",
          "onCompleteOnly": "sample string 5",
          "selectFields": [
            {
              "dsAttribute": "sample string 1",
              "dsLink": "sample string 2",
              "dsNode": "sample string 3",
              "id": "sample string 4",
              "sfField": "sample string 5",
              "sfFieldName": "sample string 6",
              "sfFolder": "sample string 7",
              "sfLockedValue": "sample string 8"
            }
          ],
          "sfObject": "sample string 6",
          "sfObjectName": "sample string 7",
          "updateFields": [
            {}
          ]
        }
      ],
      "signMessageWithX509Certificate": "sample string 34",
      "soapNamespace": "sample string 35",
      "urlToPublishTo": "sample string 36",
      "userIds": [
        "sample string 1"
      ],
      "userName": "sample string 37",
      "useSoapInterface": "sample string 38"
    }
  ],
  "totalRecords": "sample string 1"
}

Retrieves the information for the specified Docusign Connect configuration.

To use this method, you must be an account administrator and Connect must be enabled on your account.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

connectIdstringRequired

The ID of the custom Connect configuration being accessed.

Response

Successful response.

configurationslist of objectsOptional

An array of Docusign Connect configurations.

totalRecordsstringOptional

The number of results.

Errors

400

Bad Request Error