---
title: CloudSign Web API
description: test
---

[Skip to content](https://help.cloudsign.jp/en/articles/936884#main-content)

- [English](https://help.cloudsign.jp/en/articles/936884)
- [日本語](https://help.cloudsign.jp/ja/articles/936884)

English

Show submenu for translations

[![クラウドサイン ヘルプセンター](https://help.cloudsign.jp/hs-fs/hubfs/%E3%82%AF%E3%83%A9%E3%82%A6%E3%83%89%E3%82%B5%E3%82%A4%E3%83%B3_logo_horizontal_white_RGB@4x-1.png?width=170&height=40&name=%E3%82%AF%E3%83%A9%E3%82%A6%E3%83%89%E3%82%B5%E3%82%A4%E3%83%B3_logo_horizontal_white_RGB@4x-1.png)](https://help.cloudsign.jp/en/?hsLang=en)

Open main navigation

Close main navigation

- - [English](https://help.cloudsign.jp/en/articles/936884)
    - [日本語](https://help.cloudsign.jp/ja/articles/936884)

  English
  
  Show submenu for translations

 How can we help you?

- There are no suggestions because the search field is empty.

1. [CloudSign Help Center](https://help.cloudsign.jp/en?hsLang=en)
2. [API・External service linkage](https://help.cloudsign.jp/en/api-external-service-linkage?hsLang=en)
3. [Web API](https://help.cloudsign.jp/en/api-external-service-linkage?hsLang=en#web-api)

# CloudSign Web API

`Standard Plan`, `Corporate Plan`, `Business Plan`, `Enterprise Plan`

You can link the work flow system or core system that you are using with the CloudSign system. By linking the API with internal customer systems such as Salesforce or Cybozu, you can automatically link internal approval work flows and the work required for concluding contracts.

 

### What is CloudSign Web API

The CloudSign Web API is provided to allow the operations performed on CloudSign with a browser, from creating documents to sending them, to be run from a program.

Using the CloudSign Web API is recommended if you are experiencing any of the following issues.

- I want to avoid entering or sending to the incorrect recipient or sharing recipient.
- I want to increase efficiency by linking operations from internal approval procedures and concluding contracts to storage and management.
- I want to handle the large amount work related to concluding contract with limited resources

 

#### **Image of operations**

[![WebAPI1](https://help.cloudsign.jp/hs-fs/hubfs/WebAPI1.png?width=670&height=365&name=WebAPI1.png)](https://help.cloudsign.jp/hubfs/WebAPI1.png?hsLang=en)

 

| お客様 | Customer |
| --- | --- |
| \[お客様の社内システム\] | \[Customer’s internal systems\] |
| 帳票 | Forms |
| クラウドサイン経由で送付 | Send via CloudSign |
| API連携 | Link API |
| 確認依頼メール送付 | Send confirmation request email |
| \[契約相手のシステム\] | \[Contract party system\] |
| メール中のURLから書類確認 | Confirm documents from URL in email |
| 契約相手 | Contract party |
| 書類の内容に同意 | Consent to document |
| 電子署名を付与 | Apply electronic signature |
| 帳票を送付 | Send form |
| 帳票を受け取って保管 | Receive and store form |
| 社内システムに帳票を取り込み | Load form into internal system |

 

#### Web API specifications

The CloudSign Web API is based on the simple RESTful API.

Documents are hosted on SwaggerHub, and can be viewed at [https://app.swaggerhub.com/api/CloudSign/cloudsign-web\_api/](https://app.swaggerhub.com/api/CloudSign/cloudsign-web_api/)

[![WebAPI2](https://help.cloudsign.jp/hs-fs/hubfs/WebAPI2.png?width=287&height=155&name=WebAPI2.png)](https://help.cloudsign.jp/hubfs/WebAPI2.png?hsLang=en)

 

Clicking “UI” displays the list of APIs, so you can view details about individual APIs.

Please also refer to [the usage guide](https://help.cloudsign.jp/ja/articles/2681259?hsLang=en).

We can always provide more information on installation and other details,

so please send us an inquiry.

*[CloudSign Web API inquiry form](https://cs.cloudsign.jp/document_solution_api?cst=help_17)*<https://lp.cloudsign.jp/cloudsign_api.html?cst=help_17>

---

Precautions

- The following endpoints/operations are not available to customers on the Enterprise Plan.

  ```
  /team_documents
  ```

  ex.) GET /team\_documents：Get the list of documents sent and received by all members   
  ​

  ```
  /me
  ```

  ex.）GET /me：Get the user and team information on the user operating the API 

- [FAQ](https://help.cloudsign.jp/en/faq?hsLang=en#main-content)

    - [About CloudSign](https://help.cloudsign.jp/en/faq?hsLang=en#about-cloudsign)
    - [About documents](https://help.cloudsign.jp/en/faq?hsLang=en#about-documents)
    - [About operation](https://help.cloudsign.jp/en/faq?hsLang=en#about-operation)
    - [notification emails](https://help.cloudsign.jp/en/faq?hsLang=en#notification-emails)
- [Plans](https://help.cloudsign.jp/en/plans?hsLang=en#main-content)

    - [Free plan](https://help.cloudsign.jp/en/plans?hsLang=en#free-plan)
    - [Paid Plan](https://help.cloudsign.jp/en/plans?hsLang=en#paid-plan)
    - [Free option](https://help.cloudsign.jp/en/plans?hsLang=en#free-option)
    - [Paid option](https://help.cloudsign.jp/en/plans?hsLang=en#paid-option)
    - [Collaboration plan](https://help.cloudsign.jp/en/plans?hsLang=en#collaboration-plan)
- [Email address setting and login setting](https://help.cloudsign.jp/en/email-address-setting-and-login-setting?hsLang=en#main-content)

    - [login](https://help.cloudsign.jp/en/email-address-setting-and-login-setting?hsLang=en#login)
- [Sending documents](https://help.cloudsign.jp/en/sending-documents?hsLang=en#main-content)

    - [Upload and edit documents](https://help.cloudsign.jp/en/sending-documents?hsLang=en#upload-and-edit-documents)
    - [Destination settings](https://help.cloudsign.jp/en/sending-documents?hsLang=en#destination-settings)
    - [Bulk sending](https://help.cloudsign.jp/en/sending-documents?hsLang=en#bulk-sending)
    - [Settings when sending](https://help.cloudsign.jp/en/sending-documents?hsLang=en#settings-when-sending)
    - [Operations after sending](https://help.cloudsign.jp/en/sending-documents?hsLang=en#operations-after-sending)
    - [Template](https://help.cloudsign.jp/en/sending-documents?hsLang=en#template)
- [Receiving documents](https://help.cloudsign.jp/en/receiving-documents?hsLang=en#main-content)

    - [Recipient guide](https://help.cloudsign.jp/en/receiving-documents?hsLang=en#recipient-guide)
    - [Receiving docs](https://help.cloudsign.jp/en/receiving-documents?hsLang=en#receiving-docs)
- [Managing documents](https://help.cloudsign.jp/en/managing-documents?hsLang=en#main-content)

    - [Document confirmation](https://help.cloudsign.jp/en/managing-documents?hsLang=en#document-confirmation)
    - [Enter document information](https://help.cloudsign.jp/en/managing-documents?hsLang=en#enter-document-information)
    - [Document import](https://help.cloudsign.jp/en/managing-documents?hsLang=en#document-import)
- [Setting ・Administrator privilege](https://help.cloudsign.jp/en/setting-administrator-privilege?hsLang=en#main-content)

    - [Personal settings](https://help.cloudsign.jp/en/setting-administrator-privilege?hsLang=en#personal-settings)
    - [Administrator settings](https://help.cloudsign.jp/en/setting-administrator-privilege?hsLang=en#administrator-settings)
    - [Advanced settings](https://help.cloudsign.jp/en/setting-administrator-privilege?hsLang=en#advanced-settings)
- [Electronic signature](https://help.cloudsign.jp/en/electronic-signature?hsLang=en)
- [API・External service linkage](https://help.cloudsign.jp/en/api-external-service-linkage?hsLang=en#main-content)

    - [Web API](https://help.cloudsign.jp/en/api-external-service-linkage?hsLang=en#web-api)
    - [External collaboration](https://help.cloudsign.jp/en/api-external-service-linkage?hsLang=en#external-collaboration)
    - [CloudSign Payments](https://help.cloudsign.jp/en/api-external-service-linkage?hsLang=en#cloudsign-payments)
    - [Law](https://help.cloudsign.jp/en/api-external-service-linkage?hsLang=en#law)
- [Security](https://help.cloudsign.jp/en/security?hsLang=en)
- [Troubleshooting](https://help.cloudsign.jp/en/troubleshooting?hsLang=en#main-content)

    - [Login](https://help.cloudsign.jp/en/troubleshooting?hsLang=en#login)
    - [Email sending and receiving](https://help.cloudsign.jp/en/troubleshooting?hsLang=en#email-sending-and-receiving)
    - [Input items / consent related](https://help.cloudsign.jp/en/troubleshooting?hsLang=en#input-items-consent-related)
    - [PDF / signature related](https://help.cloudsign.jp/en/troubleshooting?hsLang=en#pdf-signature-related)
    - [Address settings and document information](https://help.cloudsign.jp/en/troubleshooting?hsLang=en#address-settings-and-document-information)
    - [Others](https://help.cloudsign.jp/en/troubleshooting?hsLang=en#others)

[![クラウドサイン ヘルプセンター](https://help.cloudsign.jp/hs-fs/hubfs/%E3%82%AF%E3%83%A9%E3%82%A6%E3%83%89%E3%82%B5%E3%82%A4%E3%83%B3_logo_horizontal_color_RGB@4x.png?width=170&height=40&name=%E3%82%AF%E3%83%A9%E3%82%A6%E3%83%89%E3%82%B5%E3%82%A4%E3%83%B3_logo_horizontal_color_RGB@4x.png "クラウドサイン ヘルプセンター")](https://www.cloudsign.jp/)

© 2015 Bengo4.com, Inc.