https://github.com/docusign/openapi-specifications
The official Docusign REST APIs Swagger Specifications
https://github.com/docusign/openapi-specifications
docusign docusign-openapi docusign-rest oai oai-specification official openapi swagger
Last synced: about 1 month ago
JSON representation
The official Docusign REST APIs Swagger Specifications
- Host: GitHub
- URL: https://github.com/docusign/openapi-specifications
- Owner: docusign
- License: mit
- Created: 2017-07-25T18:16:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T06:32:26.000Z (about 2 months ago)
- Last Synced: 2025-04-11T22:43:07.343Z (about 1 month ago)
- Topics: docusign, docusign-openapi, docusign-rest, oai, oai-specification, official, openapi, swagger
- Homepage:
- Size: 11.8 MB
- Stars: 22
- Watchers: 23
- Forks: 18
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docusign OpenAPI Specifications
Docusign uses the OpenAPI (OAI) Specification - formerly known as "Swagger" - to describe its REST APIs. The goal of the OAI specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service. For more info see the official [OAI](https://github.com/OAI/OpenAPI-Specification) spec.
## The Swagger file
 `esignature.rest.swagger-v2.1.json` - the full swagger file for Docusign's eSignature REST API v2.1
 `esignature.rest.swagger-v2.json` - the full swagger file for Docusign's eSignature REST API v2
 `rooms.rest.swagger-v2.json` - the full swagger file for Docusign's Rooms API v2
 `click.rest.swagger-v2.json` - the full swagger file for Docusign's Click API v1
 `admin.rest.swagger-v2.json` - the full swagger file for Docusign's Admin API v2 and v2.1
 `maestro.rest.swagger-v1.0.0.json` - the full swagger file for Docusign's Maestro API v1
 `webforms.rest.swagger-v1.1.0.json` - the full swagger file for Docusign's WebForms API v1.1
## What can I do with a Swagger file?
We use OpenAPI/Swagger files to build many of our developer tools including our [client SDKs](https://developers.docusign.com/docs/esign-rest-api/sdk-tools) using `swagger-codegen`. We also use the OAI specification to build our [API Docs](https://docs.docusign.com/esign/) and [API Explorer](https://apiexplorer.docusign.com/#/) tools. What will you build? Let us know by filing an issue in this repository.
### Vendor-specific extensions
Some post-processing is performed on our eSignature Swagger spec which includes adding a number of vendor-specific extensions prefixed with `x-ds-`. See the [Docusign-Extensions.md](Docusign-Extensions.md) file for more information.
### Releases
The DocuSign eSignature REST API is updated monthly. The Swagger file in this repository is also updated monthly. See the "Releases" tab for version information. The current release information is available from the [Developer Account (demo)](https://demo.docusign.net/restapi/service_information) and [production](https://www.docusign.net/restapi/service_information) platforms.
## Support
Please log issues through GitHub. We also have an active developer community on Stack Overflow, search the [DocusignAPI](http://stackoverflow.com/questions/tagged/docusignapi) tag.
## License
The DocuSign OpenAPI (Swagger) Files are licensed under the following [License](LICENSE).