Retrieves the base resources available for the DocuSign REST APIs.

You do not need an integrator key to view the REST API versions and resources.

Example: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system.

To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL.

Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.

Request

HTTP request

GET /v2

Parameters

Parameter NameValueDescription

Responses

CodeDescriptionReference
200

Successful response.

Resources
400

Error encountered.

errorDetails

SDK Method

Diagnostics::getResources

Definitions

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.

Resources

API resource information

resources[nameValue]

Examples

Generic JSON Response

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

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