DocuSign

Web Forms API version 1.1

The Web Forms API facilitates generating semantic HTML forms around everyday contracts.

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Web Forms API facilitates generating semantic HTML forms around everyday contracts.

Endpoints 6

Instances

  • GETLists the instances of a given web form configuration./v1.1/accounts/:accountId/forms/:formId/instances?client_user_id=string<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your…
  • POSTGets a web form instance./v1.1/accounts/:accountId/forms/:formId/instances<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your…
  • GETCreates a secure web form instance./v1.1/accounts/:accountId/forms/:formId/instances/:instanceId<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your…
  • POSTRefreshes the instance token./v1.1/accounts/:accountId/forms/:formId/instances/:instanceId/refresh<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your…

Configurations

  • GETReturns a list of web form configurations./v1.1/accounts/:accountId/forms?user_filter=all&is_standalone=true&is_published=true&sort_by=string&search=string&start_position=string&count=string<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your…
  • GETRetrieves a web form configuration./v1.1/accounts/:accountId/forms/:formId?state=draft<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your…

API details

Base URL
https://apps-d.docusign.com/api/webforms
Authentication
OAuth 2.0 (authorization code flow) with 3 scopes
Operations
6 operations on 5 pathsGET 4POST 2
Main resources
Instances 4Configurations 2
Response formats
application/json
Description format
Swagger 2.0, API version 1.1.0

How to test the Web Forms API version 1.1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Web Forms API version 1.1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists the instances of a given web form configuration.” (GET /v1.1/accounts/:accountId/forms/:formId/instances?client_user_id=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Web Forms API version 1.1?

The Web Forms API facilitates generating semantic HTML forms around everyday contracts. It is listed under Other and has 6 endpoints.

Who publishes the Web Forms API version 1.1?

It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Web Forms API version 1.1?

Requests go to https://apps-d.docusign.com/api/webforms. Endpoint paths are added to this base URL.

How do I authenticate with the Web Forms API version 1.1?

With OAuth 2.0 (authorization code flow) with 3 scopes.

How many endpoints does the Web Forms API version 1.1 have?

6 operations on 5 paths (4 GET, 2 POST). The largest groups are Instances, Configurations.

Is forking the Web Forms API version 1.1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.