API Explorer

API Explorer is a tool that enables you to test any endpoint method within the API reference documentation for a supported API. You can use API Explorer to send API calls to the Docusign developer environment and review the responses without authenticating or configuring a project. All you need is a developer account.

API Explorer is integrated directly with the API reference documentation for these Docusign APIs:

• eSignature
• Web Forms
• Notary
• Monitor
• Click
• ID Evidence
• Admin
• Rooms

To test a method, open the API reference page for that method, and then select the API Explorer tab to toggle to API Explorer. When you’re done testing the method, you can toggle back by selecting the API Reference tab.

How to use API Explorer

1. On the API Reference page for the method you want to test, select API Explorer.

   

   • If you’re not logged in, a login banner appears at the top of the page.

   • If you already have a developer account, select Log In and enter your account credentials.

   • If you don’t have a developer account, select Create Account.

     

2. Enter all required parameters for the request. Select the i icon next to a parameter name to see a brief description.

   

   • If you’re making a POST call or other API call that has a request body, enter the request body information in fields in the the Body section.

   • As you update the request body, a JSON representation is displayed to the right in the JSON preview window, below the API endpoint path.

     

   • Base64 text properties represent files. Use the Select file button in a Base64 field to choose a file. API Explorer automatically converts it to Base64 and adds it to the sample request.

   • For properties that are arrays, each field has a UI that lets you easily add and delete entries from the array.

3. Once you’ve entered all required parameters, select the Get Response button at the bottom right of the screen to test the API call.

4. The response is displayed. You can download it, copy it to the clipboard, and toggle between the response data and headers.

   

   If the response contains a PDF, the Response tab displays it in an embedded PDF viewer. For most other binary responses, the tool provides an option to view them (for images) or download them to a local file.

Download requests and responses

To download a file that contains the most recent request and response, select the Download button directly below the method name and description.