Docusign Rooms Rest Swagger V2
DocuSign Rooms REST Swagger v2 is an API connector for DocuSign Rooms, a collaboration and transaction-room platform for managing document-heavy deals.
- Base URL:
https://demo.rooms.docusign.com/restapi - Auth:
header:Authorization(pass your key via theapiKeyinput)
Operations
accounts_getaccountinformation— GET /v2/accounts/{accountId} — Gets account information.documents_getdocument— GET /v2/accounts/{accountId}/documents/{documentId} — Gets information about or the contents of a document.esignpermissionprofiles_getesignpermissionprofil— GET /v2/accounts/{accountId}/esign_permission_profiles — Gets eSignature Permission Profiles.fields_getfieldset— GET /v2/accounts/{accountId}/field_sets/{fieldSetId} — Gets a field set.formgroups_getformgroups— GET /v2/accounts/{accountId}/form_groups — Gets form groups.formgroups_getformgroup— GET /v2/accounts/{accountId}/form_groups/{formGroupId} — Gets a form group.
Inputs
apiKey— your docusign-rooms-rest-swagger-v2 API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: accounts_getaccountinformation
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: accounts_getaccountinformation, documents_getdocument, esignpermissionprofiles_getesignpermissionprofil, fields_getfieldset, formgroups_getformgroups, formgroups_getformgroup |
accountId |
string | no | — | Path parameter accountId (required by some operations). |
documentId |
string | no | — | Path parameter documentId (required by some operations). |
fieldSetId |
string | no | — | Path parameter fieldSetId (required by some operations). |
formGroupId |
string | no | — | Path parameter formGroupId (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |