Accounts: listSettings

Retrieves the account settings information for the specified account.

Request

HTTP request

GET /v2/accounts/{accountId}/settings

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

accountSettingsInformation
400

Error encountered.

errorDetails

SDK Method

Accounts::listSettings

Definitions

accountSettingsInformation

Contains account settings information.

accountSettings[nameValue]

The list of account settings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

Examples

Generic JSON Response

Response
{
  "accountSettings": [
    {}
  ]
}
Generic XML Response

Response
<accountSettingsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountSettings>
    <nameValue />
  </accountSettings>
</accountSettingsInformation> 
}} />