Get Connect configuration

GET

/v2/accounts/:accountId/connect/:connectId

GET

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

curl https://demo.docusign.net/restapi/v2/accounts/accountId/connect/connectId \
     -H "Authorization: <apiKey>"

{
  "configurations": [
    {
      "allowEnvelopePublish": "string",
      "allUsers": "string",
      "configurationType": "string",
      "connectId": "string",
      "enableLog": "string",
      "envelopeEvents": "string",
      "includeCertificateOfCompletion": "string",
      "includeCertSoapHeader": "string",
      "includeDocumentFields": "string",
      "includeDocuments": "string",
      "includeEnvelopeVoidReason": "string",
      "includeHMAC": "string",
      "includeSenderAccountasCustomField": "string",
      "includeTimeZoneInformation": "string",
      "name": "string",
      "recipientEvents": "string",
      "requiresAcknowledgement": "string",
      "signMessageWithX509Certificate": "string",
      "soapNamespace": "string",
      "urlToPublishTo": "string",
      "userIds": "string",
      "useSoapInterface": "string"
    }
  ],
  "totalRecords": "string"
}

Retrieves the information for the specified DocuSign Connect configuration.

Note: Connect must be enabled for your account to use this function.

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

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

Array of Connect Configurations

totalRecordsstringOptional

Record count.

Errors

400

Bad Request Error